diff --git a/CHANGELOG.md b/CHANGELOG.md index 181fbc92b..820d3f308 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,12 @@ -Xenon 3.0.0 +Xenon 3.0.1 ----------- -This is release 3.0.0 of Xenon. +This is release 3.0.1 of Xenon. + +Notable changes compared to v3.0.1: +----------------------------------- + +- fixed minute delay on shutdown when SSH adaptor was used (discussed as part of #654). Notable changes compared to v2.6.2: ----------------------------------- diff --git a/CITATION.cff b/CITATION.cff index 330cd85c1..c89082a66 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -58,7 +58,7 @@ authors: given-names: Arnold orcid: "https://orcid.org/0000-0003-1711-7961" cff-version: "1.0.3" -date-released: 2019-06-13 +date-released: 2019-07-31 doi: "10.5281/zenodo.597993" keywords: - Java @@ -79,4 +79,4 @@ license: Apache-2.0 message: "If you use this software, please cite it using these metadata." repository-code: "https://github.com/xenon-middleware/xenon" title: Xenon -version: "3.0.0" +version: "3.0.1" diff --git a/README.md b/README.md index 74b60b919..d98ed2117 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ and ```gradle dependencies { - compile group: 'nl.esciencecenter.xenon', name: 'xenon', version: '3.0.0' + compile group: 'nl.esciencecenter.xenon', name: 'xenon', version: '3.0.1' } ``` diff --git a/RELEASE.md b/RELEASE.md index 700dd85f8..9621ebd7d 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -38,10 +38,10 @@ to generate the metadata as used by Zenodo. Install ``cffconvert`` as follows: ```bash # install cffconvert in user space from PyPI -pip install --user cffconvert +pip3 install --user cffconvert -# change directory -cd +# change directory to xenon root dir (if needed) +# cd # check if the CITATION.cff file is valid (if there is no output, that # means it's all good) @@ -74,7 +74,7 @@ you should get something like this: Untracked files: (use "git add ..." to include in what will be committed) - docs/versions/3.0.0/ + docs/versions/3.0.1/ Add and commit these files using `git add` and `git commit` and `git push`. diff --git a/build.gradle b/build.gradle index f9f405e70..aaeace0c3 100644 --- a/build.gradle +++ b/build.gradle @@ -61,10 +61,10 @@ dependencies { compile group: 'com.google.guava', name: 'guava', version: '19.0' // webdav - compile group: 'javax.xml.bind', name: 'jaxb-api', version: '2.3.0' - compile group: 'com.sun.xml.bind', name: 'jaxb-core', version: '2.3.0' - compile group: 'com.sun.xml.bind', name: 'jaxb-impl', version: '2.3.0' - compile group: 'javax.activation', name: 'activation', version: '1.1.1' +// compile group: 'javax.xml.bind', name: 'jaxb-api', version: '2.3.0' +// compile group: 'com.sun.xml.bind', name: 'jaxb-core', version: '2.3.0' +// compile group: 'com.sun.xml.bind', name: 'jaxb-impl', version: '2.3.0' +// compile group: 'javax.activation', name: 'activation', version: '1.1.1' compile group: 'com.github.lookfirst', name: 'sardine', version: '5.8' // compile group: 'joda-time', name: 'joda-time', version: '2.8.1' diff --git a/docs/_data/version.yml b/docs/_data/version.yml index 16fb3a3a4..d0173731c 100644 --- a/docs/_data/version.yml +++ b/docs/_data/version.yml @@ -1 +1 @@ -current: 3.0.0 +current: 3.0.1 diff --git a/docs/versions/3.0.1/javadoc-devel/allclasses-index.html b/docs/versions/3.0.1/javadoc-devel/allclasses-index.html new file mode 100644 index 000000000..33274a23d --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/allclasses-index.html @@ -0,0 +1,863 @@ + + + + + +All Classes (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

All Classes

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

All Classes

+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/allpackages-index.html b/docs/versions/3.0.1/javadoc-devel/allpackages-index.html new file mode 100644 index 000000000..c51dab24b --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/allpackages-index.html @@ -0,0 +1,246 @@ + + + + + +All Packages (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

All Packages

+
+
+ +
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/constant-values.html b/docs/versions/3.0.1/javadoc-devel/constant-values.html new file mode 100644 index 000000000..ee1899d5f --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/constant-values.html @@ -0,0 +1,2155 @@ + + + + + +Constant Field Values (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Constant Field Values

+
+

Contents

+ +
+
+
+ + +
+

nl.esciencecenter.*

+ +
    +
  • + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.AdaptorLoader 
    Modifier and TypeConstant FieldValue
    + +private static final java.lang.StringCOMPONENT_NAME"AdaptorLoader"
    +
    • +
  • + + + + + + + + + + + + + + +
    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.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.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.at.AtScheduler 
    Modifier and TypeConstant FieldValue
    + +private static final java.lang.StringDEFAULT_QUEUE"a"
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.adaptors.schedulers.at.AtSchedulerAdaptor 
    Modifier and TypeConstant FieldValue
    + +public static final java.lang.StringADAPTOR_DESCRIPTION"The At Adaptor submits jobs to an at scheduler. This adaptor uses either the local or the ssh scheduler adaptor to run commands on the machine running at, and the file or the stfp filesystem adaptor to gain access to the filesystem of that machine."
    + +public static final java.lang.StringADAPTOR_NAME"at"
    + +public static final java.lang.StringPOLL_DELAY_PROPERTY"xenon.adaptors.schedulers.at.poll.delay"
    + +public static final java.lang.StringPREFIX"xenon.adaptors.schedulers.at."
    +
    • +
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    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
    + +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.nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcess 
    Modifier and TypeConstant FieldValue
    + +public static final intDEFAULT_TIMEOUT1000
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    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"
    +
    • +
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    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
    + +private static final intMINUTES_PER_HOUR60
    +
    • +
+ + + +
    +
  • + + + + + + + + + + + + + + + + + + + +
    nl.esciencecenter.xenon.utils.LocalFileSystemUtils 
    Modifier and TypeConstant FieldValue
    + +private static final java.lang.StringADAPTOR_NAME"local"
    + +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
    +
    • +
+
+
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/deprecated-list.html b/docs/versions/3.0.1/javadoc-devel/deprecated-list.html new file mode 100644 index 000000000..554184891 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/deprecated-list.html @@ -0,0 +1,146 @@ + + + + + +Deprecated List (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Deprecated API

+

Contents

+
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/element-list b/docs/versions/3.0.1/javadoc-devel/element-list new file mode 100644 index 000000000..48914b077 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/element-list @@ -0,0 +1,19 @@ +nl.esciencecenter.xenon +nl.esciencecenter.xenon.adaptors +nl.esciencecenter.xenon.adaptors.filesystems +nl.esciencecenter.xenon.adaptors.filesystems.ftp +nl.esciencecenter.xenon.adaptors.filesystems.local +nl.esciencecenter.xenon.adaptors.filesystems.sftp +nl.esciencecenter.xenon.adaptors.filesystems.webdav +nl.esciencecenter.xenon.adaptors.schedulers +nl.esciencecenter.xenon.adaptors.schedulers.at +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/3.0.1/javadoc-devel/help-doc.html b/docs/versions/3.0.1/javadoc-devel/help-doc.html new file mode 100644 index 000000000..36714e663 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/help-doc.html @@ -0,0 +1,272 @@ + + + + + +API Help (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

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. These pages may contain six categories:

    +
      +
    • Interfaces
      • +
    • Classes
      • +
    • Enums
      • +
    • Exceptions
      • +
    • Errors
      • +
    • Annotation Types
      • +
    +
    +
    • +
  • +
    +

    Class or 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 or Interface Declaration
      • +
    • Class or Interface Description
      • +
    +
    +
      +
    • Nested Class Summary
      • +
    • Field Summary
      • +
    • Property Summary
      • +
    • Constructor Summary
      • +
    • Method Summary
      • +
    +
    +
      +
    • Field Detail
      • +
    • Property 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. Classes are organized by inheritance structure starting with java.lang.Object. 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 on "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 index of all classes, interfaces, constructors, methods, and fields, as well as lists of all packages and all classes.

    +
    +
    • +
  • +
    +

    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.

    +
    +
    • +
  • +
    +

    Search

    +

    You can search for definitions of modules, packages, types, fields, methods and other terms defined in the API, using some or all of the name. "Camel-case" abbreviations are supported: for example, "InpStr" will find "InputStream" and "InputStreamReader".

    +
    +
    • +
+
+This help file applies to API documentation generated by the standard doclet.
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/index-all.html b/docs/versions/3.0.1/javadoc-devel/index-all.html new file mode 100644 index 000000000..b2f2df4db --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/index-all.html @@ -0,0 +1,5094 @@ + + + + + +Index (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
A B C D E F G H I J K L M N O P Q R S T U V W X 
All Classes All Packages + + +

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
+
 
+
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 - Class in nl.esciencecenter.xenon.adaptors
+
 
+
Adaptor(String, String, String[], XenonPropertyDescription[]) - Constructor for class nl.esciencecenter.xenon.adaptors.Adaptor
+
 
+
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.local.LocalFileAdaptor
+
+
Description of the 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.at.AtSchedulerAdaptor
+
+
Human readable 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.local.LocalFileAdaptor
+
+
The locations supported by the 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.at.AtSchedulerAdaptor
+
+
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.local.LocalFileAdaptor
+
+
Name of the local adaptor is defined in the engine.
+
+
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.at.AtSchedulerAdaptor
+
+
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
+
+
ADAPTOR_NAME - Static variable in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
 
+
AdaptorDescription - Interface in nl.esciencecenter.xenon
+
+
AdaptorStatus contains information on a specific adaptor.
+
+
AdaptorLoader - Class in nl.esciencecenter.xenon.adaptors
+
 
+
AdaptorLoader() - Constructor for class nl.esciencecenter.xenon.adaptors.AdaptorLoader
+
 
+
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_PREFIX - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.FileAdaptor
+
 
+
ADAPTORS_PREFIX - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.SchedulerAdaptor
+
 
+
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.JobSeenMap
+
 
+
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.
+
+
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.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.ScriptingUtils
+
+
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
+
 
+
AtScheduler - Class in nl.esciencecenter.xenon.adaptors.schedulers.at
+
 
+
AtScheduler(String, String, Credential, XenonPropertyDescription[], Map<String, String>) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.at.AtScheduler
+
 
+
AtSchedulerAdaptor - Class in nl.esciencecenter.xenon.adaptors.schedulers.at
+
 
+
AtSchedulerAdaptor() - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.at.AtSchedulerAdaptor
+
 
+
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) - Constructor for exception nl.esciencecenter.xenon.filesystems.AttributeNotSupportedException
+
 
+
AttributeNotSupportedException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.AttributeNotSupportedException
+
 
+
AtUtils - Class in nl.esciencecenter.xenon.adaptors.schedulers.at
+
 
+
AtUtils() - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.at.AtUtils
+
 
+
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.TransferClientInputStream
+
 
+
+ + + +

B

+
+
BadParameterException - Exception in nl.esciencecenter.xenon.adaptors.schedulers
+
+
Signals that a parameter has an invalid value.
+
+
BadParameterException(String, String) - Constructor for exception nl.esciencecenter.xenon.adaptors.schedulers.BadParameterException
+
 
+
BadParameterException(String, String, Throwable) - 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
+
 
+
BOOLEAN - nl.esciencecenter.xenon.XenonPropertyDescription.Type
+
+
Properties of type BOOLEAN can be either "true" or "false".
+
+
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.local.LocalFileAdaptor
+
+
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 - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyCallback
+
 
+
bytesCopied - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
bytesCopied() - Method in interface nl.esciencecenter.xenon.filesystems.CopyStatus
+
+
Get the number of bytes that have been copied.
+
+
bytesCopied() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
bytesToCopy - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyCallback
+
 
+
bytesToCopy - Variable 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() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyStatusImplementation
+
 
+
+ + + +

C

+
+
callback - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem.PendingCopy
+
 
+
canAllocateMultiNode(int, int) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo
+
+
Check if pe can allocate X number of cores per node on Y number of nodes
+
+
canAllocateSingleNode(int) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo
+
+
Check if pe can allocate all slots on the same node
+
+
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.webdav.WebdavFileAdaptor
+
 
+
canAppend() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
+
 
+
cancel() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem.CopyCallback
+
 
+
cancel(String) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Cancel a copy operation.
+
+
cancelJob(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtScheduler
+
 
+
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.local.LocalFileAdaptor
+
 
+
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.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) - Constructor for exception nl.esciencecenter.xenon.adaptors.shared.ssh.CertificateNotFoundException
+
 
+
CertificateNotFoundException(String, String, Throwable) - 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
+
 
+
checkAdaptorName(String) - Static method in class nl.esciencecenter.xenon.adaptors.AdaptorLoader
+
 
+
checkClientReply(String) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
checkClientReply(FTPClient, String) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
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) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtScheduler
+
+
Checks if the provided queue name is valid, and throws an exception otherwise.
+
+
checkQueue(String[], String, String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingUtils
+
+
Check if the given queueName is presents in queueNames.
+
+
checkQueueNames(String[]) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtScheduler
+
+
Checks if the queue names given are valid, and throw an exception otherwise.
+
+
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() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmSetup
+
 
+
checkVersion(Document) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineXmlParser
+
 
+
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(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
cleanupJob(List<JobExecutor>, 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.ftp.FtpFileSystem.CloseableClient
+
 
+
client - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
client - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.TransferClientInputStream
+
 
+
client - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.TransferClientOutputStream
+
 
+
client - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
client - Variable in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHConnection
+
 
+
close() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
close() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem.CloseableClient
+
 
+
close() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
close() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.TransferClientInputStream
+
 
+
close() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.TransferClientOutputStream
+
 
+
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.
+
+
CloseableClient(FTPClient) - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem.CloseableClient
+
 
+
closed - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem.CloseableClient
+
 
+
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
+
 
+
CommandNotFoundException - Exception in nl.esciencecenter.xenon.adaptors.schedulers.local
+
+
Signals that a command could not be found.
+
+
CommandNotFoundException(String, String) - Constructor for exception nl.esciencecenter.xenon.adaptors.schedulers.local.CommandNotFoundException
+
 
+
CommandNotFoundException(String, String, Throwable) - 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
+
 
+
COMPONENT_NAME - Static variable in class nl.esciencecenter.xenon.adaptors.AdaptorLoader
+
+
The name of this component, for use in exceptions
+
+
concat(String...) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingUtils
+
+
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) - Constructor for exception nl.esciencecenter.xenon.adaptors.filesystems.ConnectionLostException
+
 
+
ConnectionLostException(String, String, Throwable) - 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
+
 
+
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
+
 
+
convertFromOctal(String) - Static method in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
 
+
convertTime(FileTime) - Static method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
convertToOctal(Set<PosixFilePermission>) - Static method in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
 
+
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).
+
+
coresPerTask - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The number of cores needed per tasks.
+
+
count - Variable in class nl.esciencecenter.xenon.utils.DaemonThreadFactory
+
 
+
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) - 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.
+
+
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, 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, 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, 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, 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, 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 - nl.esciencecenter.xenon.filesystems.CopyMode
+
+
Copy to a new destination file, failing if the file already exists.
+
+
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.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.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.local.LocalFileAdaptor
+
 
+
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.at.AtSchedulerAdaptor
+
 
+
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.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 - Variable in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
credential - Variable in class nl.esciencecenter.xenon.schedulers.Scheduler
+
 
+
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.
+
+
CredentialNotFoundException - Exception in nl.esciencecenter.xenon.adaptors.shared.ssh
+
+
Signals that a credential could not be found.
+
+
CredentialNotFoundException(String, String) - Constructor for exception nl.esciencecenter.xenon.adaptors.shared.ssh.CredentialNotFoundException
+
 
+
CredentialNotFoundException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.adaptors.shared.ssh.CredentialNotFoundException
+
 
+
currentID - Static variable in class nl.esciencecenter.xenon.adaptors.Adaptor
+
 
+
+ + + +

D

+
+
DaemonThreadFactory - Class in nl.esciencecenter.xenon.utils
+
 
+
DaemonThreadFactory(String) - Constructor for class nl.esciencecenter.xenon.utils.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_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.sftp.SftpFileAdaptor
+
+
The default SSH port
+
+
DEFAULT_PORT - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
The default SSH port
+
+
DEFAULT_QUEUE - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtScheduler
+
 
+
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
+
 
+
DEFAULT_START_TIME - Static variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The default start time
+
+
DEFAULT_TIMEOUT - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcess
+
 
+
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
+
 
+
defaultRuntime - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
 
+
defaultValue - Variable in class nl.esciencecenter.xenon.XenonPropertyDescription
+
 
+
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.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.JobSeenMap
+
 
+
deleteFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
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
+
 
+
destroy(int, TimeUnit) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcess
+
+
Destroy (stop) process.
+
+
destroyProcess(ProcessHandle, int, TimeUnit) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcess
+
 
+
DirectoryNotEmptyException - Exception in nl.esciencecenter.xenon.filesystems
+
+
Signals that directory is not empty.
+
+
DirectoryNotEmptyException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.DirectoryNotEmptyException
+
 
+
DirectoryNotEmptyException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.DirectoryNotEmptyException
+
 
+
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.
+
+
DOUBLE - nl.esciencecenter.xenon.XenonPropertyDescription.Type
+
+
Properties of type DOUBLE can be converted into a 64-bit floating point number using Double.valueOf(String).
+
+
+ + + +

E

+
+
echo(Formatter, String, String, String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtUtils
+
 
+
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.
+
+
EndOfFileException - Exception in nl.esciencecenter.xenon.adaptors.filesystems
+
+
Signals that an end-of-file was encountered.
+
+
EndOfFileException(String, String) - Constructor for exception nl.esciencecenter.xenon.adaptors.filesystems.EndOfFileException
+
 
+
EndOfFileException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.adaptors.filesystems.EndOfFileException
+
 
+
endsWith(String) - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Tests if this Path ends with the given Path represented as a String.
+
+
endsWith(Path) - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Tests if this Path ends with the given Path.
+
+
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.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.
+
+
expireTime - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.JobSeenMap
+
 
+
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
+
 
+
fileAdaptors - Static variable in class nl.esciencecenter.xenon.adaptors.AdaptorLoader
+
 
+
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) - Constructor for exception nl.esciencecenter.xenon.filesystems.FileSystemClosedException
+
 
+
FileSystemClosedException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.FileSystemClosedException
+
 
+
FILL_UP - nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo.AllocationRule
+
 
+
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(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
findJob(List<JobExecutor>, 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.TransferClientOutputStream
+
 
+
ftpClient - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
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
+
 
+
FtpFileSystem.CloseableClient - Class in nl.esciencecenter.xenon.adaptors.filesystems.ftp
+
 
+
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, int) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
 
+
generate(JobDescription, Path, int) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueUtils
+
 
+
generate(JobDescription, Path, GridEngineSetup) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
generateInteractiveArguments(JobDescription, Path, UUID, int) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
 
+
generateJobScript(JobDescription, Path, String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtUtils
+
 
+
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.local.LocalFileSystem
+
 
+
getAttributes(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
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.
+
+
getAttributes(Path, DavResource) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
getBooleanProperty(String) - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Retrieves the value of a boolean property with the given name.
+
+
getBufferSize() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
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
+
 
+
getCoresPerTask() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Get the number of cores needed for each task.
+
+
getCount() - Method in class nl.esciencecenter.xenon.utils.DaemonThreadFactory
+
 
+
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.at.AtScheduler
+
 
+
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.
+
+
getDefaultRuntime() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtScheduler
+
 
+
getDefaultRuntime() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
 
+
getDefaultRuntime() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
getDefaultRuntime() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
 
+
getDefaultRuntime() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
+
+
Get the default runtime of a job in minutes.
+
+
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
+
 
+
getExpireTime() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobSeenMap
+
 
+
getFileAdaptor(String) - Static method in class nl.esciencecenter.xenon.adaptors.AdaptorLoader
+
 
+
getFileAdaptorDescriptions() - Static method in class nl.esciencecenter.xenon.adaptors.AdaptorLoader
+
 
+
getFileAdaptorNames() - Static method in class nl.esciencecenter.xenon.adaptors.AdaptorLoader
+
 
+
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.
+
+
getJobIDs(Map<String, Map<String, String>>) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtUtils
+
 
+
getJobInfo(String[]) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtScheduler
+
 
+
getJobs(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtScheduler
+
 
+
getJobs(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
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.
+
+
getJobs(List<JobExecutor>, List<String>) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
getJobStatus(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtScheduler
+
 
+
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(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.
+
+
getJobStatus(Map<String, Map<String, String>>, String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
+
Get job status.
+
+
getJobStatus(Map<String, Map<String, String>>, String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueScheduler
+
+
Get job status.
+
+
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
+
 
+
getMultiNodeParallelEnvironment(int, int, String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
+
Try to find a parallel environment that can be used to get X number of cores per node on Y number of nodes
+
+
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() - 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.
+
+
getName(int) - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Get an element of this Path.
+
+
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
+
 
+
getNextCopyID() - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
 
+
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() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.QueueInfo
+
 
+
getParallelEnvironments(GridEngineScheduler) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
 
+
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.
+
+
getPassword(SessionContext, NamedResource, int) - Method in class nl.esciencecenter.xenon.adaptors.shared.ssh.SSHUtil.PasswordProvider
+
 
+
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() - 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).
+
+
getPermissions(FTPFile) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
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
+
 
+
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.
+
+
getProperties(XenonPropertyDescription[], String, Map<String, String>) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingUtils
+
 
+
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.at.AtScheduler
+
 
+
getQueueNames() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
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.
+
+
getQueueNames(GridEngineScheduler) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
 
+
getQueues(String[], GridEngineScheduler) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
 
+
getQueueStatus(String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtScheduler
+
 
+
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.at.AtScheduler
+
 
+
getQueueStatuses(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
getQueueStatuses(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
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.
+
+
getQueueStatuses(Map<String, Map<String, String>>, String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingScheduler
+
 
+
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.
+
+
getSchedulerAdaptor(String) - Static method in class nl.esciencecenter.xenon.adaptors.AdaptorLoader
+
 
+
getSchedulerAdaptorDescriptions() - Static method in class nl.esciencecenter.xenon.adaptors.AdaptorLoader
+
 
+
getSchedulerAdaptorNames() - Static method in class nl.esciencecenter.xenon.adaptors.AdaptorLoader
+
 
+
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
+
 
+
getSingleNodeParallelEnvironment(int, String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
+
Try to find a parallel environment that can be used to get a number of cores on a single node
+
+
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
+
 
+
getStartTime() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Get the start time of the job.
+
+
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.
+
+
getStream(String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtUtils
+
 
+
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.local.LocalFileAdaptor
+
 
+
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.schedulers.ScriptingSchedulerAdaptor
+
 
+
getSupportedProperties() - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Returns the descriptions of all supported properties.
+
+
getTasks() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Get the number of tasks in this job.
+
+
getTasksPerNode() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Get the number of tasks per node.
+
+
getTempSpace() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Get the amount of temp space needed for process (in MBytes).
+
+
getType() - Method in class nl.esciencecenter.xenon.XenonPropertyDescription
+
+
Returns the type of the property.
+
+
getUniqueID() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtScheduler
+
 
+
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.ScriptingUtils
+
+
Retrieve a working directory from a JobDescription and, if necessary, resolve it against a current working directory.
+
+
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(String[], Map<String, QueueInfo>, Map<String, ParallelEnvironmentInfo>, int) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
+
Testing constructor.
+
+
GridEngineSetup(GridEngineScheduler) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineSetup
+
 
+
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
+
+
GROUP_EXECUTE - nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
+
Execute/search permission, group.
+
+
GROUP_EXECUTE_BIT - Static variable in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
 
+
GROUP_READ - nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
+
Read permission, group.
+
+
GROUP_READ_BIT - Static variable in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
 
+
GROUP_WRITE - nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
+
Write permission, group.
+
+
GROUP_WRITE_BIT - Static variable in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
 
+
+ + + +

H

+
+
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.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.JobSeenMap
+
 
+
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 - nl.esciencecenter.xenon.filesystems.CopyMode
+
+
Skip the copy if the destination file if it already exists.
+
+
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) - Constructor for exception nl.esciencecenter.xenon.adaptors.schedulers.IncompatibleVersionException
+
 
+
IncompatibleVersionException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.schedulers.IncompleteJobDescriptionException
+
 
+
IncompleteJobDescriptionException(String, String, Throwable) - 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.TransferClientInputStream
+
 
+
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.
+
+
INTEGER - nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo.AllocationRule
+
 
+
INTEGER - nl.esciencecenter.xenon.XenonPropertyDescription.Type
+
+
Properties of type INTEGER can be converted into a 32-bit signed integer using Integer.valueOf(String).
+
+
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) - Constructor for exception nl.esciencecenter.xenon.InvalidCredentialException
+
 
+
InvalidCredentialException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.schedulers.InvalidJobDescriptionException
+
 
+
InvalidJobDescriptionException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.schedulers.InvalidJobDescriptionException
+
 
+
InvalidLocationException - Exception in nl.esciencecenter.xenon
+
+
Signals that an invalid location was provided.
+
+
InvalidLocationException(String, String) - Constructor for exception nl.esciencecenter.xenon.InvalidLocationException
+
 
+
InvalidLocationException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.filesystems.InvalidOptionsException
+
 
+
InvalidOptionsException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.filesystems.InvalidPathException
+
 
+
InvalidPathException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.InvalidPropertyException
+
 
+
InvalidPropertyException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.filesystems.InvalidResumeTargetException
+
 
+
InvalidResumeTargetException(String, String, Throwable) - 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.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() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Does the path refer to an executable file ?
+
+
isExecutable(int) - Static method in class nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
+
 
+
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.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() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Does the path refer to an readable file ?
+
+
isReadable(int) - Static method in class nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
+
 
+
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
+
 
+
isStartPerJob() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Will the executable be started per job? + + true by default.
+
+
isStartPerTask() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Will the executable be started per task? + + false by default.
+
+
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() - Method in interface nl.esciencecenter.xenon.filesystems.PathAttributes
+
+
Does the path refer to a writable file ?
+
+
isWritable(int) - Static method in class nl.esciencecenter.xenon.adaptors.filesystems.PosixFileUtils
+
 
+
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
+
 
+
JobCanceledException - Exception in nl.esciencecenter.xenon.adaptors.schedulers
+
+
Signals that a jobs has been canceled by the user.
+
+
JobCanceledException(String, String) - Constructor for exception nl.esciencecenter.xenon.adaptors.schedulers.JobCanceledException
+
 
+
JobCanceledException(String, String, Throwable) - 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
+
 
+
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
+
 
+
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.
+
+
jobSeenMap - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtScheduler
+
 
+
jobSeenMap - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
JobSeenMap - Class in nl.esciencecenter.xenon.adaptors.schedulers
+
 
+
JobSeenMap() - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.JobSeenMap
+
 
+
JobSeenMap(long) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.JobSeenMap
+
 
+
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
+
 
+
jobsSeenMap - Variable 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.JobSeenMap
+
 
+
+ + + +

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.JobSeenMap
+
+
Map with the last seen time of jobs.
+
+
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.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.
+
+
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.
+
+
loadAdaptors() - Static method in class nl.esciencecenter.xenon.adaptors.AdaptorLoader
+
 
+
loaded - Static variable in class nl.esciencecenter.xenon.adaptors.AdaptorLoader
+
 
+
loadFileSystemAdaptors() - Static method in class nl.esciencecenter.xenon.adaptors.AdaptorLoader
+
 
+
loadSchedulerAdaptors() - Static method in class nl.esciencecenter.xenon.adaptors.AdaptorLoader
+
 
+
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.AdaptorLoader
+
 
+
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.at.AtScheduler
+
 
+
LOGGER - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtUtils
+
 
+
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
+
 
+
LONG - nl.esciencecenter.xenon.XenonPropertyDescription.Type
+
+
Properties of type LONG can be converted into a 64-bit signed long using Long.valueOf(String).
+
+
+ + + +

M

+
+
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.TransferClientInputStream
+
 
+
markSupported() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.TransferClientInputStream
+
 
+
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 - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The name of the job.
+
+
name - Variable in class nl.esciencecenter.xenon.utils.DaemonThreadFactory
+
 
+
name - Variable in class nl.esciencecenter.xenon.XenonPropertyDescription
+
 
+
NAME - Static variable in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
 
+
NATURAL - nl.esciencecenter.xenon.XenonPropertyDescription.Type
+
+
Properties of type NATURAL may contain only positive values, including 0.
+
+
needsSizeBeforehand() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.FileAdaptor
+
 
+
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.utils.DaemonThreadFactory
+
 
+
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
+
 
+
nextUniqueID - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtScheduler
+
 
+
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.local - package nl.esciencecenter.xenon.adaptors.filesystems.local
+
 
+
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.at - package nl.esciencecenter.xenon.adaptors.schedulers.at
+
 
+
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.
+
+
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) - Constructor for exception nl.esciencecenter.xenon.adaptors.filesystems.NoSpaceException
+
 
+
NoSpaceException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.filesystems.NoSuchCopyException
+
 
+
NoSuchCopyException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.schedulers.NoSuchJobException
+
 
+
NoSuchJobException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.filesystems.NoSuchPathException
+
 
+
NoSuchPathException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.schedulers.NoSuchQueueException
+
 
+
NoSuchQueueException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.schedulers.NoSuchQueueException
+
 
+
NotConnectedException - Exception in nl.esciencecenter.xenon.adaptors
+
+
Signals that there was no connection.
+
+
NotConnectedException(String, String) - Constructor for exception nl.esciencecenter.xenon.adaptors.NotConnectedException
+
 
+
NotConnectedException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.adaptors.NotConnectedException
+
 
+
+ + + +

O

+
+
OK_CODE - Static variable in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileAdaptor
+
 
+
open - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcessFactory
+
 
+
OS_PROPERTY - Static variable in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
 
+
OTHERS_EXECUTE - nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
+
Execute/search permission, others.
+
+
OTHERS_EXECUTE_BIT - Static variable in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
 
+
OTHERS_READ - nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
+
Read permission, others.
+
+
OTHERS_READ_BIT - Static variable in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
 
+
OTHERS_WRITE - nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
+
Write permission, others.
+
+
OTHERS_WRITE_BIT - Static variable in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
 
+
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.TransferClientOutputStream
+
 
+
owner - Variable in class nl.esciencecenter.xenon.adaptors.filesystems.PathAttributesImplementation
+
+
The owner of this file
+
+
OWNER_EXECUTE - nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
+
Execute/search permission, owner.
+
+
OWNER_EXECUTE_BIT - Static variable in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
 
+
OWNER_READ - nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
+
Read permission, owner.
+
+
OWNER_READ_BIT - Static variable in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
 
+
OWNER_WRITE - nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
+
Write permission, owner.
+
+
OWNER_WRITE_BIT - Static variable in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
+
 
+
+ + + +

P

+
+
ParallelEnvironmentInfo - Class in nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+
+
Class that holds some info on parallel environments used in Grid Engine.
+
+
ParallelEnvironmentInfo(String, int, ParallelEnvironmentInfo.AllocationRule, int) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo
+
 
+
ParallelEnvironmentInfo(Map<String, String>) - 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.
+
+
parseJobInfo(String, Set<String>) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtUtils
+
+
Parse one or more lines of queue info as produced by atq.
+
+
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"
+
+
parseJobLine(String, Set<String>, HashMap<String, Map<String, String>>) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtUtils
+
 
+
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
+
 
+
parseSubmitOutput(String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtUtils
+
 
+
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, char[]) - Constructor for class nl.esciencecenter.xenon.credentials.PasswordCredential
+
+
Create a new PasswordCredential using a char array as password.
+
+
PasswordCredential(String, String) - Constructor for class nl.esciencecenter.xenon.credentials.PasswordCredential
+
+
Create a new PasswordCredential using a String 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(boolean, String...) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
+
+
Create a new Path using the given path elements and the default 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, String...) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
+
+
Create a new Path using the given path elements and the provided 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(char, String) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
+
+
Create a new Path by parsing path using the provided separator.
+
+
Path(String) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
+
+
Create a new Path by parsing path using the default separator.
+
+
PATH_ELEMENT_LENGTH - Static variable in class nl.esciencecenter.xenon.filesystems.Path
+
+
Estimate of path element String length.
+
+
Path.PathIterator - Class in nl.esciencecenter.xenon.filesystems
+
 
+
PathAlreadyExistsException - Exception in nl.esciencecenter.xenon.filesystems
+
+
Signals that a path already exists.
+
+
PathAlreadyExistsException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.PathAlreadyExistsException
+
 
+
PathAlreadyExistsException(String, String, Throwable) - 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
+
 
+
PE_SLOTS - nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo.AllocationRule
+
 
+
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) - Constructor for exception nl.esciencecenter.xenon.adaptors.filesystems.PermissionDeniedException
+
 
+
PermissionDeniedException(String, String, Throwable) - 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.at.AtSchedulerAdaptor
+
+
Polling delay for jobs started by this adaptor.
+
+
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.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.local.LocalFileAdaptor
+
+
Local 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.at.AtSchedulerAdaptor
+
+
The prefix used by all properties related to this adaptor
+
+
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
+
 
+
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) - Constructor for exception nl.esciencecenter.xenon.PropertyTypeException
+
 
+
PropertyTypeException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.PropertyTypeException
+
 
+
protectAgainstShellMetas(String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingUtils
+
+
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
+
+
QNAMES - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtScheduler
+
 
+
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(String, int, String...) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.QueueInfo
+
+
Testing constructor
+
+
QueueInfo(Map<String, String>) - Constructor for class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.QueueInfo
+
 
+
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.TransferClientInputStream
+
 
+
read(byte[]) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.TransferClientInputStream
+
 
+
read(byte[], int, int) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.TransferClientInputStream
+
 
+
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.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.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 - 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
+
 
+
rename(Path, Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
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).
+
+
REPLACE - nl.esciencecenter.xenon.filesystems.CopyMode
+
+
If the source and destination are a regular file, the destination file will be replaced.
+
+
reset() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.TransferClientInputStream
+
 
+
resolve(String) - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Resolve a Path represented as a String against this path.
+
+
resolve(Path) - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Resolve a Path 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
+
 
+
ROUND_ROBIN - nl.esciencecenter.xenon.adaptors.schedulers.gridengine.ParallelEnvironmentInfo.AllocationRule
+
 
+
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

+
+
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
+
 
+
schedulerAdaptors - Static variable in class nl.esciencecenter.xenon.adaptors.AdaptorLoader
+
 
+
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) - Constructor for exception nl.esciencecenter.xenon.adaptors.schedulers.SchedulerClosedException
+
 
+
SchedulerClosedException(String, String, Throwable) - 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 local or 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.
+
+
setCoresPerTask(int) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Set the number of cores needed for each task.
+
+
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.
+
+
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.
+
+
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.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).
+
+
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
+
 
+
setStartPerJob() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Set if the executable must be started for once per job instead of for each task.
+
+
setStartPerTask() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Set if the executable must be started for each task instead of once per job.
+
+
setStartTime(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Set the start time of the job.
+
+
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
+
 
+
setTasks(int) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Set the number of tasks in this job.
+
+
setTasksPerNode(int) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Set the number of tasks allowed per node.
+
+
setTempSpace(int) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Set the amount of memory needed for process (in MBytes).
+
+
setup - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmScheduler
+
 
+
setupInfo - Variable in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineScheduler
+
 
+
setWorkingDirectory(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Sets the path of the working directory for the executable.
+
+
setWorkingDirectory(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Set the current working directory of this file system to directory.
+
+
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
+
+
SIZE - nl.esciencecenter.xenon.XenonPropertyDescription.Type
+
+
Properties of type SIZE can be converted into a 64-bit signed long using Long.valueOf(String).
+
+
skip(long) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.TransferClientInputStream
+
 
+
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(SshClient, 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.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).
+
+
startPerTask - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
Start the executable once per task instead of once per job?
+
+
startsWith(String) - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Tests if this Path starts with the given Path represented as a String.
+
+
startsWith(Path) - Method in class nl.esciencecenter.xenon.filesystems.Path
+
+
Tests if this Path starts with the given Path.
+
+
startsWithLinuxRoot(String) - Static method in class nl.esciencecenter.xenon.utils.LocalFileSystemUtils
+
+
Checks if the provide path starts with a valid Linux root, that is "/".
+
+
startTime - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The requested start time
+
+
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(InputStream, OutputStream) - Constructor for class nl.esciencecenter.xenon.utils.StreamForwarder
+
+
Create a new StreamForwarder and start it immediately.
+
+
StreamForwarder(String, InputStream, OutputStream, int) - 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.
+
+
STRING - nl.esciencecenter.xenon.XenonPropertyDescription.Type
+
+
Properties of type STRING are directly stored in a String without conversion.
+
+
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.at.AtScheduler
+
 
+
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.at.AtScheduler
+
 
+
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
+
 
+
substituteJobID(String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
substituteJobID(String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueUtils
+
 
+
substituteJobID(String, String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtUtils
+
 
+
substituteJobID(String, String) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.BatchProcess
+
 
+
success() - Method in class nl.esciencecenter.xenon.adaptors.schedulers.RemoteCommandRunner
+
 
+
successIgnoreError() - 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.sftp.SftpFileAdaptor
+
 
+
supportsReadingPosixPermissions() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
+
 
+
supportsRename() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.FileAdaptor
+
 
+
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.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

+
+
tasks - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The number of tasks the jobs consists of.
+
+
tasksPerNode - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The number of tasks per node
+
+
tempSpace - Variable in class nl.esciencecenter.xenon.schedulers.JobDescription
+
+
The tempspace needed (in MB) on each node/process.
+
+
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.)
+
+
TIMEOUT - Static variable in class nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshSchedulerAdaptor
+
+
Add gateway to access machine.
+
+
toAbsolutePath() - Method in class nl.esciencecenter.xenon.filesystems.Path
+
 
+
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.
+
+
toMap() - Method in class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Returns all properties that are set in a new Map.
+
+
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.PathAttributesImplementation
+
 
+
toString() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.TransferClientInputStream
+
 
+
toString() - Method in class nl.esciencecenter.xenon.adaptors.filesystems.TransferClientOutputStream
+
 
+
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
+
 
+
TransferClientInputStream - Class in nl.esciencecenter.xenon.adaptors.filesystems
+
+
Wraps an InputStream instance.
+
+
TransferClientInputStream(InputStream, Closeable) - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.TransferClientInputStream
+
 
+
TransferClientOutputStream - Class in nl.esciencecenter.xenon.adaptors.filesystems
+
+
Wraps an OutputStream instance.
+
+
TransferClientOutputStream(OutputStream, Closeable) - Constructor for class nl.esciencecenter.xenon.adaptors.filesystems.TransferClientOutputStream
+
 
+
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) - Constructor for exception nl.esciencecenter.xenon.UnknownAdaptorException
+
 
+
UnknownAdaptorException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.UnknownPropertyException
+
 
+
UnknownPropertyException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.schedulers.UnsupportedJobDescriptionException
+
 
+
UnsupportedJobDescriptionException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.UnsupportedOperationException
+
 
+
UnsupportedOperationException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.UnsupportedOperationException
+
 
+
updateRecentlySeen(String...) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobSeenMap
+
 
+
updateRecentlySeen(Set<String>) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobSeenMap
+
 
+
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_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.local.LocalFileAdaptor
+
+
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.at.AtSchedulerAdaptor
+
+
List of all properties supported by this 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, boolean) - Method in class nl.esciencecenter.xenon.adaptors.schedulers.JobQueueScheduler
+
 
+
verifyJobDescription(JobDescription, String[]) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.at.AtUtils
+
 
+
verifyJobDescription(JobDescription, String[]) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.gridengine.GridEngineUtils
+
 
+
verifyJobDescription(JobDescription, String[]) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.torque.TorqueUtils
+
 
+
verifyJobDescription(JobDescription, String[], boolean) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.slurm.SlurmUtils
+
 
+
verifyJobDescription(JobDescription, String[], String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingUtils
+
+
Do some checks on a job description.
+
+
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
+
+
verifyLoginSuccess(int) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileAdaptor
+
 
+
verifyStartTime(String, String) - Static method in class nl.esciencecenter.xenon.adaptors.schedulers.ScriptingUtils
+
+
Verify a String containing a start time.
+
+
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(byte[]) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.TransferClientOutputStream
+
 
+
write(byte[], int, int) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.TransferClientOutputStream
+
 
+
write(int) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.TransferClientOutputStream
+
 
+
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) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
writeToFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.local.LocalFileSystem
+
 
+
writeToFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.sftp.SftpFileSystem
+
 
+
writeToFile(Path) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.webdav.WebdavFileSystem
+
 
+
writeToFile(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
+
+
Open a file and return an OutputStream to write to this file.
+
+
writeToFile(Path, long) - Method in class nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem
+
 
+
writeToFile(Path, long) - 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, long) - 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.
+
+
+ + + +

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() - Constructor for class nl.esciencecenter.xenon.adaptors.XenonProperties
+
+
Creates an empty XenonProperties.
+
+
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(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 
All Classes All Packages
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/index.html b/docs/versions/3.0.1/javadoc-devel/index.html new file mode 100644 index 000000000..82f01d5fa --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/index.html @@ -0,0 +1,847 @@ + + + + + +Overview (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+

xenon 3.0.1 API for Xenon developers

+
+
+
+

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. + + + + + + + + + + + + + +
Supported properties
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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Supported properties
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
    • +
+

at

+

The At Adaptor submits jobs to an at scheduler. This adaptor uses either the local or the ssh scheduler adaptor to run commands on the machine running at, 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Supported properties
NameDescriptionExpected typeDefault
xenon.adaptors.schedulers.at.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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Supported properties
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
    • +
+

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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Supported properties
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
    • +
+

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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Supported properties
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. + + + + + + + +
Supported properties
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
    • +
+

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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Supported properties
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
    • +
+

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. + + + + + + + +
Supported properties
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
    • +
+

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. + + + + + + + +
Supported properties
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
    • +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
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.local 
nl.esciencecenter.xenon.adaptors.filesystems.sftp 
nl.esciencecenter.xenon.adaptors.filesystems.webdav 
nl.esciencecenter.xenon.adaptors.schedulers 
nl.esciencecenter.xenon.adaptors.schedulers.at 
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.
+
+
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/jquery/external/jquery/jquery.js b/docs/versions/3.0.1/javadoc-devel/jquery/external/jquery/jquery.js new file mode 100644 index 000000000..9b5206bcc --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/jquery/external/jquery/jquery.js @@ -0,0 +1,10364 @@ +/*! + * jQuery JavaScript Library v3.3.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2018-01-20T17:24Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var document = window.document; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var concat = arr.concat; + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + + + + var preservedScriptAttributes = { + type: true, + src: true, + noModule: true + }; + + function DOMEval( code, doc, node ) { + doc = doc || document; + + var i, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + if ( node[ i ] ) { + script[ i ] = node[ i ]; + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.3.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }, + + // Support: Android <=4.0 only + // Make sure we trim BOM and NBSP + rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + src = target[ name ]; + copy = options[ name ]; + + // Prevent never-ending loop + if ( target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + + if ( copyIsArray ) { + copyIsArray = false; + clone = src && Array.isArray( src ) ? src : []; + + } else { + clone = src && jQuery.isPlainObject( src ) ? src : {}; + } + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + + /* eslint-disable no-unused-vars */ + // See https://github.com/eslint/eslint/issues/6125 + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a global context + globalEval: function( code ) { + DOMEval( code ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // Support: Android <=4.0 only + trim: function( text ) { + return text == null ? + "" : + ( text + "" ).replace( rtrim, "" ); + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return concat.apply( [], ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.3 + * https://sizzlejs.com/ + * + * Copyright jQuery Foundation and other contributors + * Released under the MIT license + * http://jquery.org/license + * + * Date: 2016-08-08 + */ +(function( window ) { + +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ({}).hasOwnProperty, + arr = [], + pop = arr.pop, + push_native = arr.push, + push = arr.push, + slice = arr.slice, + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[i] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier + identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace + + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ), + + rattributeQuotes = new RegExp( "=" + whitespace + "*([^\\]'\"]*?)" + whitespace + "*\\]", "g" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace + + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace + + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + + whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ), + funescape = function( _, escaped, escapedWhitespace ) { + var high = "0x" + escaped - 0x10000; + // NaN means non-codepoint + // Support: Firefox<24 + // Workaround erroneous numeric interpretation of +"0x" + return high !== high || escapedWhitespace ? + escaped : + high < 0 ? + // BMP codepoint + String.fromCharCode( high + 0x10000 ) : + // Supplemental Plane codepoint (surrogate pair) + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + disabledAncestor = addCombinator( + function( elem ) { + return elem.disabled === true && ("form" in elem || "label" in elem); + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + (arr = slice.call( preferredDoc.childNodes )), + preferredDoc.childNodes + ); + // Support: Android<4.0 + // Detect silently failing push.apply + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + push_native.apply( target, slice.call(els) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + // Can't trust NodeList.length + while ( (target[j++] = els[i++]) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + + if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { + setDocument( context ); + } + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) { + + // ID selector + if ( (m = match[1]) ) { + + // Document context + if ( nodeType === 9 ) { + if ( (elem = context.getElementById( m )) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && (elem = newContext.getElementById( m )) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[2] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( (m = match[3]) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !compilerCache[ selector + " " ] && + (!rbuggyQSA || !rbuggyQSA.test( selector )) ) { + + if ( nodeType !== 1 ) { + newContext = context; + newSelector = selector; + + // qSA looks outside Element context, which is not what we want + // Thanks to Andrew Dupont for this workaround technique + // Support: IE <=8 + // Exclude object elements + } else if ( context.nodeName.toLowerCase() !== "object" ) { + + // Capture the context ID, setting it first if necessary + if ( (nid = context.getAttribute( "id" )) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", (nid = expando) ); + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[i] = "#" + nid + " " + toSelector( groups[i] ); + } + newSelector = groups.join( "," ); + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + } + + if ( newSelector ) { + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return (cache[ key + " " ] = value); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement("fieldset"); + + try { + return !!fn( el ); + } catch (e) { + return false; + } finally { + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split("|"), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[i] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( (cur = cur.nextSibling) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return (name === "input" || name === "button") && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + disabledAncestor( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction(function( argument ) { + argument = +argument; + return markFunction(function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ (j = matchIndexes[i]) ] ) { + seed[j] = !(matches[j] = seed[j]); + } + } + }); + }); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + // documentElement is verified for cases where it doesn't yet exist + // (such as loading iframes in IE - #4833) + var documentElement = elem && (elem.ownerDocument || elem).documentElement; + return documentElement ? documentElement.nodeName !== "HTML" : false; +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9-11, Edge + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + if ( preferredDoc !== document && + (subWindow = document.defaultView) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert(function( el ) { + el.className = "i"; + return !el.getAttribute("className"); + }); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert(function( el ) { + el.appendChild( document.createComment("") ); + return !el.getElementsByTagName("*").length; + }); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert(function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + }); + + // ID filter and find + if ( support.getById ) { + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute("id") === attrId; + }; + }; + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode("id"); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode("id"); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( (elem = elems[i++]) ) { + node = elem.getAttributeNode("id"); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find["TAG"] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( (elem = results[i++]) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( (support.qsa = rnative.test( document.querySelectorAll )) ) { + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert(function( el ) { + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll("[msallowcapture^='']").length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll("[selected]").length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push("~="); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll(":checked").length ) { + rbuggyQSA.push(":checked"); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push(".#.+[+~]"); + } + }); + + assert(function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement("input"); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll("[name=d]").length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll(":enabled").length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll(":disabled").length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll("*,:x"); + rbuggyQSA.push(",.*:"); + }); + } + + if ( (support.matchesSelector = rnative.test( (matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector) )) ) { + + assert(function( el ) { + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + }); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + )); + } : + function( a, b ) { + if ( b ) { + while ( (b = b.parentNode) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) { + + // Choose the first element that is related to our preferred document + if ( a === document || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) { + return -1; + } + if ( b === document || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + return a === document ? -1 : + b === document ? 1 : + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( (cur = cur.parentNode) ) { + ap.unshift( cur ); + } + cur = b; + while ( (cur = cur.parentNode) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[i] === bp[i] ) { + i++; + } + + return i ? + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[i], bp[i] ) : + + // Otherwise nodes in our document sort first + ap[i] === preferredDoc ? -1 : + bp[i] === preferredDoc ? 1 : + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + // Make sure that attribute selectors are quoted + expr = expr.replace( rattributeQuotes, "='$1']" ); + + if ( support.matchesSelector && documentIsHTML && + !compilerCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch (e) {} + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + // Set document vars if needed + if ( ( context.ownerDocument || context ) !== document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + (val = elem.getAttributeNode(name)) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return (sel + "").replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( (elem = results[i++]) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + // If no nodeType, this is expected to be an array + while ( (node = elem[i++]) ) { + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[1] = match[1].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape ); + + if ( match[2] === "~=" ) { + match[3] = " " + match[3] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[1] = match[1].toLowerCase(); + + if ( match[1].slice( 0, 3 ) === "nth" ) { + // nth-* requires argument + if ( !match[3] ) { + Sizzle.error( match[0] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) ); + match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" ); + + // other types prohibit arguments + } else if ( match[3] ) { + Sizzle.error( match[0] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[6] && match[2]; + + if ( matchExpr["CHILD"].test( match[0] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[3] ) { + match[2] = match[4] || match[5] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + // Get excess from tokenize (recursively) + (excess = tokenize( unquoted, true )) && + // advance to the next closing parenthesis + (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) { + + // excess is a negative index + match[0] = match[0].slice( 0, excess ); + match[2] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { return true; } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) && + classCache( className, function( elem ) { + return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== "undefined" && elem.getAttribute("class") || "" ); + }); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + }; + }, + + "CHILD": function( type, what, argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( (node = node[ dir ]) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( (node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + (diff = nodeIndex = 0) || start.pop()) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + // Use previously-cached element index if available + if ( useCache ) { + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + // Use the same loop as above to seek `elem` from the start + while ( (node = ++nodeIndex && node && node[ dir ] || + (diff = nodeIndex = 0) || start.pop()) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction(function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[i] ); + seed[ idx ] = !( matches[ idx ] = matched[i] ); + } + }) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + // Potentially complex pseudos + "not": markFunction(function( selector ) { + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction(function( seed, matches, context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( (elem = unmatched[i]) ) { + seed[i] = !(matches[i] = elem); + } + } + }) : + function( elem, context, xml ) { + input[0] = elem; + matcher( input, null, xml, results ); + // Don't keep the element (issue #299) + input[0] = null; + return !results.pop(); + }; + }), + + "has": markFunction(function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + }), + + "contains": markFunction(function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || elem.innerText || getText( elem ) ).indexOf( text ) > -1; + }; + }), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + // lang value must be a valid identifier + if ( !ridentifier.test(lang || "") ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( (elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( (elem = elem.parentNode) && elem.nodeType === 1 ); + return false; + }; + }), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected); + }, + + "selected": function( elem ) { + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos["empty"]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo(function() { + return [ 0 ]; + }), + + "last": createPositionalPseudo(function( matchIndexes, length ) { + return [ length - 1 ]; + }), + + "eq": createPositionalPseudo(function( matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + }), + + "even": createPositionalPseudo(function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "odd": createPositionalPseudo(function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "lt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "gt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }) + } +}; + +Expr.pseudos["nth"] = Expr.pseudos["eq"]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || (match = rcomma.exec( soFar )) ) { + if ( match ) { + // Don't consume trailing commas as valid + soFar = soFar.slice( match[0].length ) || soFar; + } + groups.push( (tokens = []) ); + } + + matched = false; + + // Combinators + if ( (match = rcombinators.exec( soFar )) ) { + matched = match.shift(); + tokens.push({ + value: matched, + // Cast descendant combinators to space + type: match[0].replace( rtrim, " " ) + }); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] || + (match = preFilters[ type ]( match ))) ) { + matched = match.shift(); + tokens.push({ + value: matched, + type: type, + matches: match + }); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[i].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || (elem[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || (outerCache[ elem.uniqueID ] = {}); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( (oldCache = uniqueCache[ key ]) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return (newCache[ 2 ] = oldCache[ 2 ]); + } else { + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[i]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[0]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[i], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( (elem = unmatched[i]) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction(function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( (elem = temp[i]) ) { + matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) ) { + // Restore matcherIn since elem is not yet a final match + temp.push( (matcherIn[i] = elem) ); + } + } + postFinder( null, (matcherOut = []), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) && + (temp = postFinder ? indexOf( seed, elem ) : preMap[i]) > -1 ) { + + seed[temp] = !(results[temp] = elem); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + }); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[0].type ], + implicitRelative = leadingRelative || Expr.relative[" "], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + (checkContext = context).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( (matcher = Expr.relative[ tokens[i].type ]) ) { + matchers = [ addCombinator(elementMatcher( matchers ), matcher) ]; + } else { + matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[j].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" }) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( (tokens = tokens.slice( j )) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find["TAG"]( "*", outermost ), + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1), + len = elems.length; + + if ( outermost ) { + outermostContext = context === document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && (elem = elems[i]) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + if ( !context && elem.ownerDocument !== document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( (matcher = elementMatchers[j++]) ) { + if ( matcher( elem, context || document, xml) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + // They will have gone through all possible matchers + if ( (elem = !matcher && elem) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( (matcher = setMatchers[j++]) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !(unmatched[i] || setMatched[i]) ) { + setMatched[i] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[i] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( (selector = compiled.selector || selector) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[0] = match[0].slice( 0 ); + if ( tokens.length > 2 && (token = tokens[0]).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[1].type ] ) { + + context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[i]; + + // Abort if we hit a combinator + if ( Expr.relative[ (type = token.type) ] ) { + break; + } + if ( (find = Expr.find[ type ]) ) { + // Search, expanding context for leading sibling combinators + if ( (seed = find( + token.matches[0].replace( runescape, funescape ), + rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context + )) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split("").sort( sortOrder ).join("") === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert(function( el ) { + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement("fieldset") ) & 1; +}); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert(function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute("href") === "#" ; +}) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + }); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert(function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +}) ) { + addHandle( "value", function( elem, name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + }); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert(function( el ) { + return el.getAttribute("disabled") == null; +}) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + (val = elem.getAttributeNode( name )) && val.specified ? + val.value : + null; + } + }); +} + +return Sizzle; + +})( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( nodeName( elem, "iframe" ) ) { + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + jQuery.contains( elem.ownerDocument, elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + +var swap = function( elem, options, callback, args ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.apply( elem, args || [] ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]+)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // Support: IE <=9 only + option: [ 1, "" ], + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +// Support: IE <=9 only +wrapMap.optgroup = wrapMap.option; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, contains, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + contains = jQuery.contains( elem.ownerDocument, elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( contains ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; +} )(); +var documentElement = document.documentElement; + + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 only +// See #13393 for more info +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Don't attach events to noData or text/comment nodes (but allow plain objects) + if ( !elemData ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = {}; + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + // Make a writable jQuery.Event from the native event object + var event = jQuery.event.fix( nativeEvent ); + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + handlers = ( dataPriv.get( this, "events" ) || {} )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // Triggered event must either 1) have no namespace, or 2) have namespace(s) + // a subset or equal to those in the bound event (both can have no namespace). + if ( !event.rnamespace || event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + focus: { + + // Fire native event if possible so blur/focus sequence is correct + trigger: function() { + if ( this !== safeActiveElement() && this.focus ) { + this.focus(); + return false; + } + }, + delegateType: "focusin" + }, + blur: { + trigger: function() { + if ( this === safeActiveElement() && this.blur ) { + this.blur(); + return false; + } + }, + delegateType: "focusout" + }, + click: { + + // For checkbox, fire native event so checked state will be right + trigger: function() { + if ( this.type === "checkbox" && this.click && nodeName( this, "input" ) ) { + this.click(); + return false; + } + }, + + // For cross-browser consistency, don't fire native .click() on links + _default: function( event ) { + return nodeName( event.target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + /* eslint-disable max-len */ + + // See https://github.com/eslint/eslint/issues/3229 + rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi, + + /* eslint-enable */ + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, pdataCur, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.access( src ); + pdataCur = dataPriv.set( dest, pdataOld ); + events = pdataOld.events; + + if ( events ) { + delete pdataCur.handle; + pdataCur.events = {}; + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = concat.apply( [], args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl ) { + jQuery._evalUrl( node.src ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), doc, node ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && jQuery.contains( node.ownerDocument, node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html.replace( rxhtmlTag, "<$1>" ); + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = jQuery.contains( elem.ownerDocument, elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + div.style.position = "absolute"; + scrollboxSizeVal = div.offsetWidth === 36 || "absolute"; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !jQuery.contains( elem.ownerDocument, elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }, + + cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style; + +// Return a css property mapped to a potentially vendor prefixed property +function vendorPropName( name ) { + + // Shortcut for names that are not vendor prefixed + if ( name in emptyStyle ) { + return name; + } + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a property mapped along what jQuery.cssProps suggests or to +// a vendor prefixed property. +function finalPropName( name ) { + var ret = jQuery.cssProps[ name ]; + if ( !ret ) { + ret = jQuery.cssProps[ name ] = vendorPropName( name ) || name; + } + return ret; +} + +function setPositiveNumber( elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + ) ); + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + val = curCSS( elem, dimension, styles ), + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox; + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + // Check for style in case a browser which returns unreliable values + // for getComputedStyle silently falls back to the reliable elem.style + valueIsBorderBox = valueIsBorderBox && + ( support.boxSizingReliable() || val === elem.style[ dimension ] ); + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + if ( val === "auto" || + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) { + + val = elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ]; + + // offsetWidth/offsetHeight provide border-box values + valueIsBorderBox = true; + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + if ( type === "number" ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra && boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ); + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && support.scrollboxSize() === styles.position ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && + ( tween.elem.style[ jQuery.cssProps[ tween.prop ] ] != null || + jQuery.cssHooks[ tween.prop ] ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue && type !== false ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( dataPriv.get( cur, "events" ) || {} )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + var doc = this.ownerDocument || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = Date.now(); + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() ] = match[ 2 ]; + } + } + match = responseHeaders[ key.toLowerCase() ]; + } + return match == null ? null : match; + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce++ ) + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + + +jQuery._evalUrl = function( url ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + "throws": true + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain requests + if ( s.crossDomain ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( "\r\n"; + +// inject VBScript +document.write(IEBinaryToArray_ByteStr_Script); + +global.JSZipUtils._getBinaryFromXHR = function (xhr) { + var binary = xhr.responseBody; + var byteMapping = {}; + for ( var i = 0; i < 256; i++ ) { + for ( var j = 0; j < 256; j++ ) { + byteMapping[ String.fromCharCode( i + (j << 8) ) ] = + String.fromCharCode(i) + String.fromCharCode(j); + } + } + var rawBytes = IEBinaryToArray_ByteStr(binary); + var lastChr = IEBinaryToArray_ByteStr_Last(binary); + return rawBytes.replace(/[\s\S]/g, function( match ) { + return byteMapping[match]; + }) + lastChr; +}; + +// enforcing Stuk's coding style +// vim: set shiftwidth=4 softtabstop=4: + +},{}]},{},[1]) +; diff --git a/docs/versions/3.0.1/javadoc-devel/jquery/jszip-utils/dist/jszip-utils-ie.min.js b/docs/versions/3.0.1/javadoc-devel/jquery/jszip-utils/dist/jszip-utils-ie.min.js new file mode 100644 index 000000000..93d8bc8ef --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/jquery/jszip-utils/dist/jszip-utils-ie.min.js @@ -0,0 +1,10 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g\r\n";document.write(b),a.JSZipUtils._getBinaryFromXHR=function(a){for(var b=a.responseBody,c={},d=0;256>d;d++)for(var e=0;256>e;e++)c[String.fromCharCode(d+(e<<8))]=String.fromCharCode(d)+String.fromCharCode(e);var f=IEBinaryToArray_ByteStr(b),g=IEBinaryToArray_ByteStr_Last(b);return f.replace(/[\s\S]/g,function(a){return c[a]})+g}},{}]},{},[1]); diff --git a/docs/versions/3.0.1/javadoc-devel/jquery/jszip-utils/dist/jszip-utils.js b/docs/versions/3.0.1/javadoc-devel/jquery/jszip-utils/dist/jszip-utils.js new file mode 100644 index 000000000..775895ec9 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/jquery/jszip-utils/dist/jszip-utils.js @@ -0,0 +1,118 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(e){"object"==typeof exports?module.exports=e():"function"==typeof define&&define.amd?define(e):"undefined"!=typeof window?window.JSZipUtils=e():"undefined"!=typeof global?global.JSZipUtils=e():"undefined"!=typeof self&&(self.JSZipUtils=e())}(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(a){"object"==typeof exports?module.exports=a():"function"==typeof define&&define.amd?define(a):"undefined"!=typeof window?window.JSZipUtils=a():"undefined"!=typeof global?global.JSZipUtils=a():"undefined"!=typeof self&&(self.JSZipUtils=a())}(function(){return function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g + +(c) 2009-2016 Stuart Knightley +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip/master/LICENSE.markdown. + +JSZip uses the library pako released under the MIT license : +https://github.com/nodeca/pako/blob/master/LICENSE +*/ + +(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.JSZip = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o> 2; + enc2 = ((chr1 & 3) << 4) | (chr2 >> 4); + enc3 = remainingBytes > 1 ? (((chr2 & 15) << 2) | (chr3 >> 6)) : 64; + enc4 = remainingBytes > 2 ? (chr3 & 63) : 64; + + output.push(_keyStr.charAt(enc1) + _keyStr.charAt(enc2) + _keyStr.charAt(enc3) + _keyStr.charAt(enc4)); + + } + + return output.join(""); +}; + +// public method for decoding +exports.decode = function(input) { + var chr1, chr2, chr3; + var enc1, enc2, enc3, enc4; + var i = 0, resultIndex = 0; + + var dataUrlPrefix = "data:"; + + if (input.substr(0, dataUrlPrefix.length) === dataUrlPrefix) { + // This is a common error: people give a data url + // (data:image/png;base64,iVBOR...) with a {base64: true} and + // wonders why things don't work. + // We can detect that the string input looks like a data url but we + // *can't* be sure it is one: removing everything up to the comma would + // be too dangerous. + throw new Error("Invalid base64 input, it looks like a data url."); + } + + input = input.replace(/[^A-Za-z0-9\+\/\=]/g, ""); + + var totalLength = input.length * 3 / 4; + if(input.charAt(input.length - 1) === _keyStr.charAt(64)) { + totalLength--; + } + if(input.charAt(input.length - 2) === _keyStr.charAt(64)) { + totalLength--; + } + if (totalLength % 1 !== 0) { + // totalLength is not an integer, the length does not match a valid + // base64 content. That can happen if: + // - the input is not a base64 content + // - the input is *almost* a base64 content, with a extra chars at the + // beginning or at the end + // - the input uses a base64 variant (base64url for example) + throw new Error("Invalid base64 input, bad content length."); + } + var output; + if (support.uint8array) { + output = new Uint8Array(totalLength|0); + } else { + output = new Array(totalLength|0); + } + + while (i < input.length) { + + enc1 = _keyStr.indexOf(input.charAt(i++)); + enc2 = _keyStr.indexOf(input.charAt(i++)); + enc3 = _keyStr.indexOf(input.charAt(i++)); + enc4 = _keyStr.indexOf(input.charAt(i++)); + + chr1 = (enc1 << 2) | (enc2 >> 4); + chr2 = ((enc2 & 15) << 4) | (enc3 >> 2); + chr3 = ((enc3 & 3) << 6) | enc4; + + output[resultIndex++] = chr1; + + if (enc3 !== 64) { + output[resultIndex++] = chr2; + } + if (enc4 !== 64) { + output[resultIndex++] = chr3; + } + + } + + return output; +}; + +},{"./support":30,"./utils":32}],2:[function(require,module,exports){ +'use strict'; + +var external = require("./external"); +var DataWorker = require('./stream/DataWorker'); +var DataLengthProbe = require('./stream/DataLengthProbe'); +var Crc32Probe = require('./stream/Crc32Probe'); +var DataLengthProbe = require('./stream/DataLengthProbe'); + +/** + * Represent a compressed object, with everything needed to decompress it. + * @constructor + * @param {number} compressedSize the size of the data compressed. + * @param {number} uncompressedSize the size of the data after decompression. + * @param {number} crc32 the crc32 of the decompressed file. + * @param {object} compression the type of compression, see lib/compressions.js. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the compressed data. + */ +function CompressedObject(compressedSize, uncompressedSize, crc32, compression, data) { + this.compressedSize = compressedSize; + this.uncompressedSize = uncompressedSize; + this.crc32 = crc32; + this.compression = compression; + this.compressedContent = data; +} + +CompressedObject.prototype = { + /** + * Create a worker to get the uncompressed content. + * @return {GenericWorker} the worker. + */ + getContentWorker : function () { + var worker = new DataWorker(external.Promise.resolve(this.compressedContent)) + .pipe(this.compression.uncompressWorker()) + .pipe(new DataLengthProbe("data_length")); + + var that = this; + worker.on("end", function () { + if(this.streamInfo['data_length'] !== that.uncompressedSize) { + throw new Error("Bug : uncompressed data size mismatch"); + } + }); + return worker; + }, + /** + * Create a worker to get the compressed content. + * @return {GenericWorker} the worker. + */ + getCompressedWorker : function () { + return new DataWorker(external.Promise.resolve(this.compressedContent)) + .withStreamInfo("compressedSize", this.compressedSize) + .withStreamInfo("uncompressedSize", this.uncompressedSize) + .withStreamInfo("crc32", this.crc32) + .withStreamInfo("compression", this.compression) + ; + } +}; + +/** + * Chain the given worker with other workers to compress the content with the + * given compresion. + * @param {GenericWorker} uncompressedWorker the worker to pipe. + * @param {Object} compression the compression object. + * @param {Object} compressionOptions the options to use when compressing. + * @return {GenericWorker} the new worker compressing the content. + */ +CompressedObject.createWorkerFrom = function (uncompressedWorker, compression, compressionOptions) { + return uncompressedWorker + .pipe(new Crc32Probe()) + .pipe(new DataLengthProbe("uncompressedSize")) + .pipe(compression.compressWorker(compressionOptions)) + .pipe(new DataLengthProbe("compressedSize")) + .withStreamInfo("compression", compression); +}; + +module.exports = CompressedObject; + +},{"./external":6,"./stream/Crc32Probe":25,"./stream/DataLengthProbe":26,"./stream/DataWorker":27}],3:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require("./stream/GenericWorker"); + +exports.STORE = { + magic: "\x00\x00", + compressWorker : function (compressionOptions) { + return new GenericWorker("STORE compression"); + }, + uncompressWorker : function () { + return new GenericWorker("STORE decompression"); + } +}; +exports.DEFLATE = require('./flate'); + +},{"./flate":7,"./stream/GenericWorker":28}],4:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); + +/** + * The following functions come from pako, from pako/lib/zlib/crc32.js + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Use ordinary array, since untyped makes no boost here +function makeTable() { + var c, table = []; + + for(var n =0; n < 256; n++){ + c = n; + for(var k =0; k < 8; k++){ + c = ((c&1) ? (0xEDB88320 ^ (c >>> 1)) : (c >>> 1)); + } + table[n] = c; + } + + return table; +} + +// Create table on load. Just 255 signed longs. Not a problem. +var crcTable = makeTable(); + + +function crc32(crc, buf, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ buf[i]) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +// That's all for the pako functions. + +/** + * Compute the crc32 of a string. + * This is almost the same as the function crc32, but for strings. Using the + * same function for the two use cases leads to horrible performances. + * @param {Number} crc the starting value of the crc. + * @param {String} str the string to use. + * @param {Number} len the length of the string. + * @param {Number} pos the starting position for the crc32 computation. + * @return {Number} the computed crc32. + */ +function crc32str(crc, str, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ str.charCodeAt(i)) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +module.exports = function crc32wrapper(input, crc) { + if (typeof input === "undefined" || !input.length) { + return 0; + } + + var isArray = utils.getTypeOf(input) !== "string"; + + if(isArray) { + return crc32(crc|0, input, input.length, 0); + } else { + return crc32str(crc|0, input, input.length, 0); + } +}; + +},{"./utils":32}],5:[function(require,module,exports){ +'use strict'; +exports.base64 = false; +exports.binary = false; +exports.dir = false; +exports.createFolders = true; +exports.date = null; +exports.compression = null; +exports.compressionOptions = null; +exports.comment = null; +exports.unixPermissions = null; +exports.dosPermissions = null; + +},{}],6:[function(require,module,exports){ +/* global Promise */ +'use strict'; + +// load the global object first: +// - it should be better integrated in the system (unhandledRejection in node) +// - the environment may have a custom Promise implementation (see zone.js) +var ES6Promise = null; +if (typeof Promise !== "undefined") { + ES6Promise = Promise; +} else { + ES6Promise = require("lie"); +} + +/** + * Let the user use/change some implementations. + */ +module.exports = { + Promise: ES6Promise +}; + +},{"lie":58}],7:[function(require,module,exports){ +'use strict'; +var USE_TYPEDARRAY = (typeof Uint8Array !== 'undefined') && (typeof Uint16Array !== 'undefined') && (typeof Uint32Array !== 'undefined'); + +var pako = require("pako"); +var utils = require("./utils"); +var GenericWorker = require("./stream/GenericWorker"); + +var ARRAY_TYPE = USE_TYPEDARRAY ? "uint8array" : "array"; + +exports.magic = "\x08\x00"; + +/** + * Create a worker that uses pako to inflate/deflate. + * @constructor + * @param {String} action the name of the pako function to call : either "Deflate" or "Inflate". + * @param {Object} options the options to use when (de)compressing. + */ +function FlateWorker(action, options) { + GenericWorker.call(this, "FlateWorker/" + action); + + this._pako = null; + this._pakoAction = action; + this._pakoOptions = options; + // the `meta` object from the last chunk received + // this allow this worker to pass around metadata + this.meta = {}; +} + +utils.inherits(FlateWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +FlateWorker.prototype.processChunk = function (chunk) { + this.meta = chunk.meta; + if (this._pako === null) { + this._createPako(); + } + this._pako.push(utils.transformTo(ARRAY_TYPE, chunk.data), false); +}; + +/** + * @see GenericWorker.flush + */ +FlateWorker.prototype.flush = function () { + GenericWorker.prototype.flush.call(this); + if (this._pako === null) { + this._createPako(); + } + this._pako.push([], true); +}; +/** + * @see GenericWorker.cleanUp + */ +FlateWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this._pako = null; +}; + +/** + * Create the _pako object. + * TODO: lazy-loading this object isn't the best solution but it's the + * quickest. The best solution is to lazy-load the worker list. See also the + * issue #446. + */ +FlateWorker.prototype._createPako = function () { + this._pako = new pako[this._pakoAction]({ + raw: true, + level: this._pakoOptions.level || -1 // default compression + }); + var self = this; + this._pako.onData = function(data) { + self.push({ + data : data, + meta : self.meta + }); + }; +}; + +exports.compressWorker = function (compressionOptions) { + return new FlateWorker("Deflate", compressionOptions); +}; +exports.uncompressWorker = function () { + return new FlateWorker("Inflate", {}); +}; + +},{"./stream/GenericWorker":28,"./utils":32,"pako":59}],8:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); +var utf8 = require('../utf8'); +var crc32 = require('../crc32'); +var signature = require('../signature'); + +/** + * Transform an integer into a string in hexadecimal. + * @private + * @param {number} dec the number to convert. + * @param {number} bytes the number of bytes to generate. + * @returns {string} the result. + */ +var decToHex = function(dec, bytes) { + var hex = "", i; + for (i = 0; i < bytes; i++) { + hex += String.fromCharCode(dec & 0xff); + dec = dec >>> 8; + } + return hex; +}; + +/** + * Generate the UNIX part of the external file attributes. + * @param {Object} unixPermissions the unix permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * adapted from http://unix.stackexchange.com/questions/14705/the-zip-formats-external-file-attribute : + * + * TTTTsstrwxrwxrwx0000000000ADVSHR + * ^^^^____________________________ file type, see zipinfo.c (UNX_*) + * ^^^_________________________ setuid, setgid, sticky + * ^^^^^^^^^________________ permissions + * ^^^^^^^^^^______ not used ? + * ^^^^^^ DOS attribute bits : Archive, Directory, Volume label, System file, Hidden, Read only + */ +var generateUnixExternalFileAttr = function (unixPermissions, isDir) { + + var result = unixPermissions; + if (!unixPermissions) { + // I can't use octal values in strict mode, hence the hexa. + // 040775 => 0x41fd + // 0100664 => 0x81b4 + result = isDir ? 0x41fd : 0x81b4; + } + return (result & 0xFFFF) << 16; +}; + +/** + * Generate the DOS part of the external file attributes. + * @param {Object} dosPermissions the dos permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * Bit 0 Read-Only + * Bit 1 Hidden + * Bit 2 System + * Bit 3 Volume Label + * Bit 4 Directory + * Bit 5 Archive + */ +var generateDosExternalFileAttr = function (dosPermissions, isDir) { + + // the dir flag is already set for compatibility + return (dosPermissions || 0) & 0x3F; +}; + +/** + * Generate the various parts used in the construction of the final zip file. + * @param {Object} streamInfo the hash with informations about the compressed file. + * @param {Boolean} streamedContent is the content streamed ? + * @param {Boolean} streamingEnded is the stream finished ? + * @param {number} offset the current offset from the start of the zip file. + * @param {String} platform let's pretend we are this platform (change platform dependents fields) + * @param {Function} encodeFileName the function to encode the file name / comment. + * @return {Object} the zip parts. + */ +var generateZipParts = function(streamInfo, streamedContent, streamingEnded, offset, platform, encodeFileName) { + var file = streamInfo['file'], + compression = streamInfo['compression'], + useCustomEncoding = encodeFileName !== utf8.utf8encode, + encodedFileName = utils.transformTo("string", encodeFileName(file.name)), + utfEncodedFileName = utils.transformTo("string", utf8.utf8encode(file.name)), + comment = file.comment, + encodedComment = utils.transformTo("string", encodeFileName(comment)), + utfEncodedComment = utils.transformTo("string", utf8.utf8encode(comment)), + useUTF8ForFileName = utfEncodedFileName.length !== file.name.length, + useUTF8ForComment = utfEncodedComment.length !== comment.length, + dosTime, + dosDate, + extraFields = "", + unicodePathExtraField = "", + unicodeCommentExtraField = "", + dir = file.dir, + date = file.date; + + + var dataInfo = { + crc32 : 0, + compressedSize : 0, + uncompressedSize : 0 + }; + + // if the content is streamed, the sizes/crc32 are only available AFTER + // the end of the stream. + if (!streamedContent || streamingEnded) { + dataInfo.crc32 = streamInfo['crc32']; + dataInfo.compressedSize = streamInfo['compressedSize']; + dataInfo.uncompressedSize = streamInfo['uncompressedSize']; + } + + var bitflag = 0; + if (streamedContent) { + // Bit 3: the sizes/crc32 are set to zero in the local header. + // The correct values are put in the data descriptor immediately + // following the compressed data. + bitflag |= 0x0008; + } + if (!useCustomEncoding && (useUTF8ForFileName || useUTF8ForComment)) { + // Bit 11: Language encoding flag (EFS). + bitflag |= 0x0800; + } + + + var extFileAttr = 0; + var versionMadeBy = 0; + if (dir) { + // dos or unix, we set the dos dir flag + extFileAttr |= 0x00010; + } + if(platform === "UNIX") { + versionMadeBy = 0x031E; // UNIX, version 3.0 + extFileAttr |= generateUnixExternalFileAttr(file.unixPermissions, dir); + } else { // DOS or other, fallback to DOS + versionMadeBy = 0x0014; // DOS, version 2.0 + extFileAttr |= generateDosExternalFileAttr(file.dosPermissions, dir); + } + + // date + // @see http://www.delorie.com/djgpp/doc/rbinter/it/52/13.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/65/16.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/66/16.html + + dosTime = date.getUTCHours(); + dosTime = dosTime << 6; + dosTime = dosTime | date.getUTCMinutes(); + dosTime = dosTime << 5; + dosTime = dosTime | date.getUTCSeconds() / 2; + + dosDate = date.getUTCFullYear() - 1980; + dosDate = dosDate << 4; + dosDate = dosDate | (date.getUTCMonth() + 1); + dosDate = dosDate << 5; + dosDate = dosDate | date.getUTCDate(); + + if (useUTF8ForFileName) { + // set the unicode path extra field. unzip needs at least one extra + // field to correctly handle unicode path, so using the path is as good + // as any other information. This could improve the situation with + // other archive managers too. + // This field is usually used without the utf8 flag, with a non + // unicode path in the header (winrar, winzip). This helps (a bit) + // with the messy Windows' default compressed folders feature but + // breaks on p7zip which doesn't seek the unicode path extra field. + // So for now, UTF-8 everywhere ! + unicodePathExtraField = + // Version + decToHex(1, 1) + + // NameCRC32 + decToHex(crc32(encodedFileName), 4) + + // UnicodeName + utfEncodedFileName; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x70" + + // size + decToHex(unicodePathExtraField.length, 2) + + // content + unicodePathExtraField; + } + + if(useUTF8ForComment) { + + unicodeCommentExtraField = + // Version + decToHex(1, 1) + + // CommentCRC32 + decToHex(crc32(encodedComment), 4) + + // UnicodeName + utfEncodedComment; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x63" + + // size + decToHex(unicodeCommentExtraField.length, 2) + + // content + unicodeCommentExtraField; + } + + var header = ""; + + // version needed to extract + header += "\x0A\x00"; + // general purpose bit flag + header += decToHex(bitflag, 2); + // compression method + header += compression.magic; + // last mod file time + header += decToHex(dosTime, 2); + // last mod file date + header += decToHex(dosDate, 2); + // crc-32 + header += decToHex(dataInfo.crc32, 4); + // compressed size + header += decToHex(dataInfo.compressedSize, 4); + // uncompressed size + header += decToHex(dataInfo.uncompressedSize, 4); + // file name length + header += decToHex(encodedFileName.length, 2); + // extra field length + header += decToHex(extraFields.length, 2); + + + var fileRecord = signature.LOCAL_FILE_HEADER + header + encodedFileName + extraFields; + + var dirRecord = signature.CENTRAL_FILE_HEADER + + // version made by (00: DOS) + decToHex(versionMadeBy, 2) + + // file header (common to file and central directory) + header + + // file comment length + decToHex(encodedComment.length, 2) + + // disk number start + "\x00\x00" + + // internal file attributes TODO + "\x00\x00" + + // external file attributes + decToHex(extFileAttr, 4) + + // relative offset of local header + decToHex(offset, 4) + + // file name + encodedFileName + + // extra field + extraFields + + // file comment + encodedComment; + + return { + fileRecord: fileRecord, + dirRecord: dirRecord + }; +}; + +/** + * Generate the EOCD record. + * @param {Number} entriesCount the number of entries in the zip file. + * @param {Number} centralDirLength the length (in bytes) of the central dir. + * @param {Number} localDirLength the length (in bytes) of the local dir. + * @param {String} comment the zip file comment as a binary string. + * @param {Function} encodeFileName the function to encode the comment. + * @return {String} the EOCD record. + */ +var generateCentralDirectoryEnd = function (entriesCount, centralDirLength, localDirLength, comment, encodeFileName) { + var dirEnd = ""; + var encodedComment = utils.transformTo("string", encodeFileName(comment)); + + // end of central dir signature + dirEnd = signature.CENTRAL_DIRECTORY_END + + // number of this disk + "\x00\x00" + + // number of the disk with the start of the central directory + "\x00\x00" + + // total number of entries in the central directory on this disk + decToHex(entriesCount, 2) + + // total number of entries in the central directory + decToHex(entriesCount, 2) + + // size of the central directory 4 bytes + decToHex(centralDirLength, 4) + + // offset of start of central directory with respect to the starting disk number + decToHex(localDirLength, 4) + + // .ZIP file comment length + decToHex(encodedComment.length, 2) + + // .ZIP file comment + encodedComment; + + return dirEnd; +}; + +/** + * Generate data descriptors for a file entry. + * @param {Object} streamInfo the hash generated by a worker, containing informations + * on the file entry. + * @return {String} the data descriptors. + */ +var generateDataDescriptors = function (streamInfo) { + var descriptor = ""; + descriptor = signature.DATA_DESCRIPTOR + + // crc-32 4 bytes + decToHex(streamInfo['crc32'], 4) + + // compressed size 4 bytes + decToHex(streamInfo['compressedSize'], 4) + + // uncompressed size 4 bytes + decToHex(streamInfo['uncompressedSize'], 4); + + return descriptor; +}; + + +/** + * A worker to concatenate other workers to create a zip file. + * @param {Boolean} streamFiles `true` to stream the content of the files, + * `false` to accumulate it. + * @param {String} comment the comment to use. + * @param {String} platform the platform to use, "UNIX" or "DOS". + * @param {Function} encodeFileName the function to encode file names and comments. + */ +function ZipFileWorker(streamFiles, comment, platform, encodeFileName) { + GenericWorker.call(this, "ZipFileWorker"); + // The number of bytes written so far. This doesn't count accumulated chunks. + this.bytesWritten = 0; + // The comment of the zip file + this.zipComment = comment; + // The platform "generating" the zip file. + this.zipPlatform = platform; + // the function to encode file names and comments. + this.encodeFileName = encodeFileName; + // Should we stream the content of the files ? + this.streamFiles = streamFiles; + // If `streamFiles` is false, we will need to accumulate the content of the + // files to calculate sizes / crc32 (and write them *before* the content). + // This boolean indicates if we are accumulating chunks (it will change a lot + // during the lifetime of this worker). + this.accumulate = false; + // The buffer receiving chunks when accumulating content. + this.contentBuffer = []; + // The list of generated directory records. + this.dirRecords = []; + // The offset (in bytes) from the beginning of the zip file for the current source. + this.currentSourceOffset = 0; + // The total number of entries in this zip file. + this.entriesCount = 0; + // the name of the file currently being added, null when handling the end of the zip file. + // Used for the emited metadata. + this.currentFile = null; + + + + this._sources = []; +} +utils.inherits(ZipFileWorker, GenericWorker); + +/** + * @see GenericWorker.push + */ +ZipFileWorker.prototype.push = function (chunk) { + + var currentFilePercent = chunk.meta.percent || 0; + var entriesCount = this.entriesCount; + var remainingFiles = this._sources.length; + + if(this.accumulate) { + this.contentBuffer.push(chunk); + } else { + this.bytesWritten += chunk.data.length; + + GenericWorker.prototype.push.call(this, { + data : chunk.data, + meta : { + currentFile : this.currentFile, + percent : entriesCount ? (currentFilePercent + 100 * (entriesCount - remainingFiles - 1)) / entriesCount : 100 + } + }); + } +}; + +/** + * The worker started a new source (an other worker). + * @param {Object} streamInfo the streamInfo object from the new source. + */ +ZipFileWorker.prototype.openedSource = function (streamInfo) { + this.currentSourceOffset = this.bytesWritten; + this.currentFile = streamInfo['file'].name; + + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + + // don't stream folders (because they don't have any content) + if(streamedContent) { + var record = generateZipParts(streamInfo, streamedContent, false, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + } else { + // we need to wait for the whole file before pushing anything + this.accumulate = true; + } +}; + +/** + * The worker finished a source (an other worker). + * @param {Object} streamInfo the streamInfo object from the finished source. + */ +ZipFileWorker.prototype.closedSource = function (streamInfo) { + this.accumulate = false; + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + var record = generateZipParts(streamInfo, streamedContent, true, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + + this.dirRecords.push(record.dirRecord); + if(streamedContent) { + // after the streamed file, we put data descriptors + this.push({ + data : generateDataDescriptors(streamInfo), + meta : {percent:100} + }); + } else { + // the content wasn't streamed, we need to push everything now + // first the file record, then the content + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + while(this.contentBuffer.length) { + this.push(this.contentBuffer.shift()); + } + } + this.currentFile = null; +}; + +/** + * @see GenericWorker.flush + */ +ZipFileWorker.prototype.flush = function () { + + var localDirLength = this.bytesWritten; + for(var i = 0; i < this.dirRecords.length; i++) { + this.push({ + data : this.dirRecords[i], + meta : {percent:100} + }); + } + var centralDirLength = this.bytesWritten - localDirLength; + + var dirEnd = generateCentralDirectoryEnd(this.dirRecords.length, centralDirLength, localDirLength, this.zipComment, this.encodeFileName); + + this.push({ + data : dirEnd, + meta : {percent:100} + }); +}; + +/** + * Prepare the next source to be read. + */ +ZipFileWorker.prototype.prepareNextSource = function () { + this.previous = this._sources.shift(); + this.openedSource(this.previous.streamInfo); + if (this.isPaused) { + this.previous.pause(); + } else { + this.previous.resume(); + } +}; + +/** + * @see GenericWorker.registerPrevious + */ +ZipFileWorker.prototype.registerPrevious = function (previous) { + this._sources.push(previous); + var self = this; + + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.closedSource(self.previous.streamInfo); + if(self._sources.length) { + self.prepareNextSource(); + } else { + self.end(); + } + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; +}; + +/** + * @see GenericWorker.resume + */ +ZipFileWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this.previous && this._sources.length) { + this.prepareNextSource(); + return true; + } + if (!this.previous && !this._sources.length && !this.generatedError) { + this.end(); + return true; + } +}; + +/** + * @see GenericWorker.error + */ +ZipFileWorker.prototype.error = function (e) { + var sources = this._sources; + if(!GenericWorker.prototype.error.call(this, e)) { + return false; + } + for(var i = 0; i < sources.length; i++) { + try { + sources[i].error(e); + } catch(e) { + // the `error` exploded, nothing to do + } + } + return true; +}; + +/** + * @see GenericWorker.lock + */ +ZipFileWorker.prototype.lock = function () { + GenericWorker.prototype.lock.call(this); + var sources = this._sources; + for(var i = 0; i < sources.length; i++) { + sources[i].lock(); + } +}; + +module.exports = ZipFileWorker; + +},{"../crc32":4,"../signature":23,"../stream/GenericWorker":28,"../utf8":31,"../utils":32}],9:[function(require,module,exports){ +'use strict'; + +var compressions = require('../compressions'); +var ZipFileWorker = require('./ZipFileWorker'); + +/** + * Find the compression to use. + * @param {String} fileCompression the compression defined at the file level, if any. + * @param {String} zipCompression the compression defined at the load() level. + * @return {Object} the compression object to use. + */ +var getCompression = function (fileCompression, zipCompression) { + + var compressionName = fileCompression || zipCompression; + var compression = compressions[compressionName]; + if (!compression) { + throw new Error(compressionName + " is not a valid compression method !"); + } + return compression; +}; + +/** + * Create a worker to generate a zip file. + * @param {JSZip} zip the JSZip instance at the right root level. + * @param {Object} options to generate the zip file. + * @param {String} comment the comment to use. + */ +exports.generateWorker = function (zip, options, comment) { + + var zipFileWorker = new ZipFileWorker(options.streamFiles, comment, options.platform, options.encodeFileName); + var entriesCount = 0; + try { + + zip.forEach(function (relativePath, file) { + entriesCount++; + var compression = getCompression(file.options.compression, options.compression); + var compressionOptions = file.options.compressionOptions || options.compressionOptions || {}; + var dir = file.dir, date = file.date; + + file._compressWorker(compression, compressionOptions) + .withStreamInfo("file", { + name : relativePath, + dir : dir, + date : date, + comment : file.comment || "", + unixPermissions : file.unixPermissions, + dosPermissions : file.dosPermissions + }) + .pipe(zipFileWorker); + }); + zipFileWorker.entriesCount = entriesCount; + } catch (e) { + zipFileWorker.error(e); + } + + return zipFileWorker; +}; + +},{"../compressions":3,"./ZipFileWorker":8}],10:[function(require,module,exports){ +'use strict'; + +/** + * Representation a of zip file in js + * @constructor + */ +function JSZip() { + // if this constructor is used without `new`, it adds `new` before itself: + if(!(this instanceof JSZip)) { + return new JSZip(); + } + + if(arguments.length) { + throw new Error("The constructor with parameters has been removed in JSZip 3.0, please check the upgrade guide."); + } + + // object containing the files : + // { + // "folder/" : {...}, + // "folder/data.txt" : {...} + // } + this.files = {}; + + this.comment = null; + + // Where we are in the hierarchy + this.root = ""; + this.clone = function() { + var newObj = new JSZip(); + for (var i in this) { + if (typeof this[i] !== "function") { + newObj[i] = this[i]; + } + } + return newObj; + }; +} +JSZip.prototype = require('./object'); +JSZip.prototype.loadAsync = require('./load'); +JSZip.support = require('./support'); +JSZip.defaults = require('./defaults'); + +// TODO find a better way to handle this version, +// a require('package.json').version doesn't work with webpack, see #327 +JSZip.version = "3.1.5"; + +JSZip.loadAsync = function (content, options) { + return new JSZip().loadAsync(content, options); +}; + +JSZip.external = require("./external"); +module.exports = JSZip; + +},{"./defaults":5,"./external":6,"./load":11,"./object":15,"./support":30}],11:[function(require,module,exports){ +'use strict'; +var utils = require('./utils'); +var external = require("./external"); +var utf8 = require('./utf8'); +var utils = require('./utils'); +var ZipEntries = require('./zipEntries'); +var Crc32Probe = require('./stream/Crc32Probe'); +var nodejsUtils = require("./nodejsUtils"); + +/** + * Check the CRC32 of an entry. + * @param {ZipEntry} zipEntry the zip entry to check. + * @return {Promise} the result. + */ +function checkEntryCRC32(zipEntry) { + return new external.Promise(function (resolve, reject) { + var worker = zipEntry.decompressed.getContentWorker().pipe(new Crc32Probe()); + worker.on("error", function (e) { + reject(e); + }) + .on("end", function () { + if (worker.streamInfo.crc32 !== zipEntry.decompressed.crc32) { + reject(new Error("Corrupted zip : CRC32 mismatch")); + } else { + resolve(); + } + }) + .resume(); + }); +} + +module.exports = function(data, options) { + var zip = this; + options = utils.extend(options || {}, { + base64: false, + checkCRC32: false, + optimizedBinaryString: false, + createFolders: false, + decodeFileName: utf8.utf8decode + }); + + if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + return external.Promise.reject(new Error("JSZip can't accept a stream when loading a zip file.")); + } + + return utils.prepareContent("the loaded zip file", data, true, options.optimizedBinaryString, options.base64) + .then(function(data) { + var zipEntries = new ZipEntries(options); + zipEntries.load(data); + return zipEntries; + }).then(function checkCRC32(zipEntries) { + var promises = [external.Promise.resolve(zipEntries)]; + var files = zipEntries.files; + if (options.checkCRC32) { + for (var i = 0; i < files.length; i++) { + promises.push(checkEntryCRC32(files[i])); + } + } + return external.Promise.all(promises); + }).then(function addFiles(results) { + var zipEntries = results.shift(); + var files = zipEntries.files; + for (var i = 0; i < files.length; i++) { + var input = files[i]; + zip.file(input.fileNameStr, input.decompressed, { + binary: true, + optimizedBinaryString: true, + date: input.date, + dir: input.dir, + comment : input.fileCommentStr.length ? input.fileCommentStr : null, + unixPermissions : input.unixPermissions, + dosPermissions : input.dosPermissions, + createFolders: options.createFolders + }); + } + if (zipEntries.zipComment.length) { + zip.comment = zipEntries.zipComment; + } + + return zip; + }); +}; + +},{"./external":6,"./nodejsUtils":14,"./stream/Crc32Probe":25,"./utf8":31,"./utils":32,"./zipEntries":33}],12:[function(require,module,exports){ +"use strict"; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); + +/** + * A worker that use a nodejs stream as source. + * @constructor + * @param {String} filename the name of the file entry for this stream. + * @param {Readable} stream the nodejs stream. + */ +function NodejsStreamInputAdapter(filename, stream) { + GenericWorker.call(this, "Nodejs stream input adapter for " + filename); + this._upstreamEnded = false; + this._bindStream(stream); +} + +utils.inherits(NodejsStreamInputAdapter, GenericWorker); + +/** + * Prepare the stream and bind the callbacks on it. + * Do this ASAP on node 0.10 ! A lazy binding doesn't always work. + * @param {Stream} stream the nodejs stream to use. + */ +NodejsStreamInputAdapter.prototype._bindStream = function (stream) { + var self = this; + this._stream = stream; + stream.pause(); + stream + .on("data", function (chunk) { + self.push({ + data: chunk, + meta : { + percent : 0 + } + }); + }) + .on("error", function (e) { + if(self.isPaused) { + this.generatedError = e; + } else { + self.error(e); + } + }) + .on("end", function () { + if(self.isPaused) { + self._upstreamEnded = true; + } else { + self.end(); + } + }); +}; +NodejsStreamInputAdapter.prototype.pause = function () { + if(!GenericWorker.prototype.pause.call(this)) { + return false; + } + this._stream.pause(); + return true; +}; +NodejsStreamInputAdapter.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if(this._upstreamEnded) { + this.end(); + } else { + this._stream.resume(); + } + + return true; +}; + +module.exports = NodejsStreamInputAdapter; + +},{"../stream/GenericWorker":28,"../utils":32}],13:[function(require,module,exports){ +'use strict'; + +var Readable = require('readable-stream').Readable; + +var utils = require('../utils'); +utils.inherits(NodejsStreamOutputAdapter, Readable); + +/** +* A nodejs stream using a worker as source. +* @see the SourceWrapper in http://nodejs.org/api/stream.html +* @constructor +* @param {StreamHelper} helper the helper wrapping the worker +* @param {Object} options the nodejs stream options +* @param {Function} updateCb the update callback. +*/ +function NodejsStreamOutputAdapter(helper, options, updateCb) { + Readable.call(this, options); + this._helper = helper; + + var self = this; + helper.on("data", function (data, meta) { + if (!self.push(data)) { + self._helper.pause(); + } + if(updateCb) { + updateCb(meta); + } + }) + .on("error", function(e) { + self.emit('error', e); + }) + .on("end", function () { + self.push(null); + }); +} + + +NodejsStreamOutputAdapter.prototype._read = function() { + this._helper.resume(); +}; + +module.exports = NodejsStreamOutputAdapter; + +},{"../utils":32,"readable-stream":16}],14:[function(require,module,exports){ +'use strict'; + +module.exports = { + /** + * True if this is running in Nodejs, will be undefined in a browser. + * In a browser, browserify won't include this file and the whole module + * will be resolved an empty object. + */ + isNode : typeof Buffer !== "undefined", + /** + * Create a new nodejs Buffer from an existing content. + * @param {Object} data the data to pass to the constructor. + * @param {String} encoding the encoding to use. + * @return {Buffer} a new Buffer. + */ + newBufferFrom: function(data, encoding) { + // XXX We can't use `Buffer.from` which comes from `Uint8Array.from` + // in nodejs v4 (< v.4.5). It's not the expected implementation (and + // has a different signature). + // see https://github.com/nodejs/node/issues/8053 + // A condition on nodejs' version won't solve the issue as we don't + // control the Buffer polyfills that may or may not be used. + return new Buffer(data, encoding); + }, + /** + * Create a new nodejs Buffer with the specified size. + * @param {Integer} size the size of the buffer. + * @return {Buffer} a new Buffer. + */ + allocBuffer: function (size) { + if (Buffer.alloc) { + return Buffer.alloc(size); + } else { + return new Buffer(size); + } + }, + /** + * Find out if an object is a Buffer. + * @param {Object} b the object to test. + * @return {Boolean} true if the object is a Buffer, false otherwise. + */ + isBuffer : function(b){ + return Buffer.isBuffer(b); + }, + + isStream : function (obj) { + return obj && + typeof obj.on === "function" && + typeof obj.pause === "function" && + typeof obj.resume === "function"; + } +}; + +},{}],15:[function(require,module,exports){ +'use strict'; +var utf8 = require('./utf8'); +var utils = require('./utils'); +var GenericWorker = require('./stream/GenericWorker'); +var StreamHelper = require('./stream/StreamHelper'); +var defaults = require('./defaults'); +var CompressedObject = require('./compressedObject'); +var ZipObject = require('./zipObject'); +var generate = require("./generate"); +var nodejsUtils = require("./nodejsUtils"); +var NodejsStreamInputAdapter = require("./nodejs/NodejsStreamInputAdapter"); + + +/** + * Add a file in the current folder. + * @private + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data of the file + * @param {Object} originalOptions the options of the file + * @return {Object} the new file. + */ +var fileAdd = function(name, data, originalOptions) { + // be sure sub folders exist + var dataType = utils.getTypeOf(data), + parent; + + + /* + * Correct options. + */ + + var o = utils.extend(originalOptions || {}, defaults); + o.date = o.date || new Date(); + if (o.compression !== null) { + o.compression = o.compression.toUpperCase(); + } + + if (typeof o.unixPermissions === "string") { + o.unixPermissions = parseInt(o.unixPermissions, 8); + } + + // UNX_IFDIR 0040000 see zipinfo.c + if (o.unixPermissions && (o.unixPermissions & 0x4000)) { + o.dir = true; + } + // Bit 4 Directory + if (o.dosPermissions && (o.dosPermissions & 0x0010)) { + o.dir = true; + } + + if (o.dir) { + name = forceTrailingSlash(name); + } + if (o.createFolders && (parent = parentFolder(name))) { + folderAdd.call(this, parent, true); + } + + var isUnicodeString = dataType === "string" && o.binary === false && o.base64 === false; + if (!originalOptions || typeof originalOptions.binary === "undefined") { + o.binary = !isUnicodeString; + } + + + var isCompressedEmpty = (data instanceof CompressedObject) && data.uncompressedSize === 0; + + if (isCompressedEmpty || o.dir || !data || data.length === 0) { + o.base64 = false; + o.binary = true; + data = ""; + o.compression = "STORE"; + dataType = "string"; + } + + /* + * Convert content to fit. + */ + + var zipObjectContent = null; + if (data instanceof CompressedObject || data instanceof GenericWorker) { + zipObjectContent = data; + } else if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + zipObjectContent = new NodejsStreamInputAdapter(name, data); + } else { + zipObjectContent = utils.prepareContent(name, data, o.binary, o.optimizedBinaryString, o.base64); + } + + var object = new ZipObject(name, zipObjectContent, o); + this.files[name] = object; + /* + TODO: we can't throw an exception because we have async promises + (we can have a promise of a Date() for example) but returning a + promise is useless because file(name, data) returns the JSZip + object for chaining. Should we break that to allow the user + to catch the error ? + + return external.Promise.resolve(zipObjectContent) + .then(function () { + return object; + }); + */ +}; + +/** + * Find the parent folder of the path. + * @private + * @param {string} path the path to use + * @return {string} the parent folder, or "" + */ +var parentFolder = function (path) { + if (path.slice(-1) === '/') { + path = path.substring(0, path.length - 1); + } + var lastSlash = path.lastIndexOf('/'); + return (lastSlash > 0) ? path.substring(0, lastSlash) : ""; +}; + +/** + * Returns the path with a slash at the end. + * @private + * @param {String} path the path to check. + * @return {String} the path with a trailing slash. + */ +var forceTrailingSlash = function(path) { + // Check the name ends with a / + if (path.slice(-1) !== "/") { + path += "/"; // IE doesn't like substr(-1) + } + return path; +}; + +/** + * Add a (sub) folder in the current folder. + * @private + * @param {string} name the folder's name + * @param {boolean=} [createFolders] If true, automatically create sub + * folders. Defaults to false. + * @return {Object} the new folder. + */ +var folderAdd = function(name, createFolders) { + createFolders = (typeof createFolders !== 'undefined') ? createFolders : defaults.createFolders; + + name = forceTrailingSlash(name); + + // Does this folder already exist? + if (!this.files[name]) { + fileAdd.call(this, name, null, { + dir: true, + createFolders: createFolders + }); + } + return this.files[name]; +}; + +/** +* Cross-window, cross-Node-context regular expression detection +* @param {Object} object Anything +* @return {Boolean} true if the object is a regular expression, +* false otherwise +*/ +function isRegExp(object) { + return Object.prototype.toString.call(object) === "[object RegExp]"; +} + +// return the actual prototype of JSZip +var out = { + /** + * @see loadAsync + */ + load: function() { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + + /** + * Call a callback function for each entry at this folder level. + * @param {Function} cb the callback function: + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + */ + forEach: function(cb) { + var filename, relativePath, file; + for (filename in this.files) { + if (!this.files.hasOwnProperty(filename)) { + continue; + } + file = this.files[filename]; + relativePath = filename.slice(this.root.length, filename.length); + if (relativePath && filename.slice(0, this.root.length) === this.root) { // the file is in the current root + cb(relativePath, file); // TODO reverse the parameters ? need to be clean AND consistent with the filter search fn... + } + } + }, + + /** + * Filter nested files/folders with the specified function. + * @param {Function} search the predicate to use : + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + * @return {Array} An array of matching elements. + */ + filter: function(search) { + var result = []; + this.forEach(function (relativePath, entry) { + if (search(relativePath, entry)) { // the file matches the function + result.push(entry); + } + + }); + return result; + }, + + /** + * Add a file to the zip file, or search a file. + * @param {string|RegExp} name The name of the file to add (if data is defined), + * the name of the file to find (if no data) or a regex to match files. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data The file data, either raw or base64 encoded + * @param {Object} o File options + * @return {JSZip|Object|Array} this JSZip object (when adding a file), + * a file (when searching by string) or an array of files (when searching by regex). + */ + file: function(name, data, o) { + if (arguments.length === 1) { + if (isRegExp(name)) { + var regexp = name; + return this.filter(function(relativePath, file) { + return !file.dir && regexp.test(relativePath); + }); + } + else { // text + var obj = this.files[this.root + name]; + if (obj && !obj.dir) { + return obj; + } else { + return null; + } + } + } + else { // more than one argument : we have data ! + name = this.root + name; + fileAdd.call(this, name, data, o); + } + return this; + }, + + /** + * Add a directory to the zip file, or search. + * @param {String|RegExp} arg The name of the directory to add, or a regex to search folders. + * @return {JSZip} an object with the new directory as the root, or an array containing matching folders. + */ + folder: function(arg) { + if (!arg) { + return this; + } + + if (isRegExp(arg)) { + return this.filter(function(relativePath, file) { + return file.dir && arg.test(relativePath); + }); + } + + // else, name is a new folder + var name = this.root + arg; + var newFolder = folderAdd.call(this, name); + + // Allow chaining by returning a new object with this folder as the root + var ret = this.clone(); + ret.root = newFolder.name; + return ret; + }, + + /** + * Delete a file, or a directory and all sub-files, from the zip + * @param {string} name the name of the file to delete + * @return {JSZip} this JSZip object + */ + remove: function(name) { + name = this.root + name; + var file = this.files[name]; + if (!file) { + // Look for any folders + if (name.slice(-1) !== "/") { + name += "/"; + } + file = this.files[name]; + } + + if (file && !file.dir) { + // file + delete this.files[name]; + } else { + // maybe a folder, delete recursively + var kids = this.filter(function(relativePath, file) { + return file.name.slice(0, name.length) === name; + }); + for (var i = 0; i < kids.length; i++) { + delete this.files[kids[i].name]; + } + } + + return this; + }, + + /** + * Generate the complete zip file + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the zip file + */ + generate: function(options) { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + /** + * Generate the complete zip file as an internal stream. + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {StreamHelper} the streamed zip file. + */ + generateInternalStream: function(options) { + var worker, opts = {}; + try { + opts = utils.extend(options || {}, { + streamFiles: false, + compression: "STORE", + compressionOptions : null, + type: "", + platform: "DOS", + comment: null, + mimeType: 'application/zip', + encodeFileName: utf8.utf8encode + }); + + opts.type = opts.type.toLowerCase(); + opts.compression = opts.compression.toUpperCase(); + + // "binarystring" is prefered but the internals use "string". + if(opts.type === "binarystring") { + opts.type = "string"; + } + + if (!opts.type) { + throw new Error("No output type specified."); + } + + utils.checkSupport(opts.type); + + // accept nodejs `process.platform` + if( + opts.platform === 'darwin' || + opts.platform === 'freebsd' || + opts.platform === 'linux' || + opts.platform === 'sunos' + ) { + opts.platform = "UNIX"; + } + if (opts.platform === 'win32') { + opts.platform = "DOS"; + } + + var comment = opts.comment || this.comment || ""; + worker = generate.generateWorker(this, opts, comment); + } catch (e) { + worker = new GenericWorker("error"); + worker.error(e); + } + return new StreamHelper(worker, opts.type || "string", opts.mimeType); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateAsync: function(options, onUpdate) { + return this.generateInternalStream(options).accumulate(onUpdate); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateNodeStream: function(options, onUpdate) { + options = options || {}; + if (!options.type) { + options.type = "nodebuffer"; + } + return this.generateInternalStream(options).toNodejsStream(onUpdate); + } +}; +module.exports = out; + +},{"./compressedObject":2,"./defaults":5,"./generate":9,"./nodejs/NodejsStreamInputAdapter":12,"./nodejsUtils":14,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31,"./utils":32,"./zipObject":35}],16:[function(require,module,exports){ +/* + * This file is used by module bundlers (browserify/webpack/etc) when + * including a stream implementation. We use "readable-stream" to get a + * consistent behavior between nodejs versions but bundlers often have a shim + * for "stream". Using this shim greatly improve the compatibility and greatly + * reduce the final size of the bundle (only one stream implementation, not + * two). + */ +module.exports = require("stream"); + +},{"stream":undefined}],17:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function ArrayReader(data) { + DataReader.call(this, data); + for(var i = 0; i < this.data.length; i++) { + data[i] = data[i] & 0xFF; + } +} +utils.inherits(ArrayReader, DataReader); +/** + * @see DataReader.byteAt + */ +ArrayReader.prototype.byteAt = function(i) { + return this.data[this.zero + i]; +}; +/** + * @see DataReader.lastIndexOfSignature + */ +ArrayReader.prototype.lastIndexOfSignature = function(sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3); + for (var i = this.length - 4; i >= 0; --i) { + if (this.data[i] === sig0 && this.data[i + 1] === sig1 && this.data[i + 2] === sig2 && this.data[i + 3] === sig3) { + return i - this.zero; + } + } + + return -1; +}; +/** + * @see DataReader.readAndCheckSignature + */ +ArrayReader.prototype.readAndCheckSignature = function (sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3), + data = this.readData(4); + return sig0 === data[0] && sig1 === data[1] && sig2 === data[2] && sig3 === data[3]; +}; +/** + * @see DataReader.readData + */ +ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + return []; + } + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = ArrayReader; + +},{"../utils":32,"./DataReader":18}],18:[function(require,module,exports){ +'use strict'; +var utils = require('../utils'); + +function DataReader(data) { + this.data = data; // type : see implementation + this.length = data.length; + this.index = 0; + this.zero = 0; +} +DataReader.prototype = { + /** + * Check that the offset will not go too far. + * @param {string} offset the additional offset to check. + * @throws {Error} an Error if the offset is out of bounds. + */ + checkOffset: function(offset) { + this.checkIndex(this.index + offset); + }, + /** + * Check that the specified index will not be too far. + * @param {string} newIndex the index to check. + * @throws {Error} an Error if the index is out of bounds. + */ + checkIndex: function(newIndex) { + if (this.length < this.zero + newIndex || newIndex < 0) { + throw new Error("End of data reached (data length = " + this.length + ", asked index = " + (newIndex) + "). Corrupted zip ?"); + } + }, + /** + * Change the index. + * @param {number} newIndex The new index. + * @throws {Error} if the new index is out of the data. + */ + setIndex: function(newIndex) { + this.checkIndex(newIndex); + this.index = newIndex; + }, + /** + * Skip the next n bytes. + * @param {number} n the number of bytes to skip. + * @throws {Error} if the new index is out of the data. + */ + skip: function(n) { + this.setIndex(this.index + n); + }, + /** + * Get the byte at the specified index. + * @param {number} i the index to use. + * @return {number} a byte. + */ + byteAt: function(i) { + // see implementations + }, + /** + * Get the next number with a given byte size. + * @param {number} size the number of bytes to read. + * @return {number} the corresponding number. + */ + readInt: function(size) { + var result = 0, + i; + this.checkOffset(size); + for (i = this.index + size - 1; i >= this.index; i--) { + result = (result << 8) + this.byteAt(i); + } + this.index += size; + return result; + }, + /** + * Get the next string with a given byte size. + * @param {number} size the number of bytes to read. + * @return {string} the corresponding string. + */ + readString: function(size) { + return utils.transformTo("string", this.readData(size)); + }, + /** + * Get raw data without conversion, bytes. + * @param {number} size the number of bytes to read. + * @return {Object} the raw data, implementation specific. + */ + readData: function(size) { + // see implementations + }, + /** + * Find the last occurence of a zip signature (4 bytes). + * @param {string} sig the signature to find. + * @return {number} the index of the last occurence, -1 if not found. + */ + lastIndexOfSignature: function(sig) { + // see implementations + }, + /** + * Read the signature (4 bytes) at the current position and compare it with sig. + * @param {string} sig the expected signature + * @return {boolean} true if the signature matches, false otherwise. + */ + readAndCheckSignature: function(sig) { + // see implementations + }, + /** + * Get the next date. + * @return {Date} the date. + */ + readDate: function() { + var dostime = this.readInt(4); + return new Date(Date.UTC( + ((dostime >> 25) & 0x7f) + 1980, // year + ((dostime >> 21) & 0x0f) - 1, // month + (dostime >> 16) & 0x1f, // day + (dostime >> 11) & 0x1f, // hour + (dostime >> 5) & 0x3f, // minute + (dostime & 0x1f) << 1)); // second + } +}; +module.exports = DataReader; + +},{"../utils":32}],19:[function(require,module,exports){ +'use strict'; +var Uint8ArrayReader = require('./Uint8ArrayReader'); +var utils = require('../utils'); + +function NodeBufferReader(data) { + Uint8ArrayReader.call(this, data); +} +utils.inherits(NodeBufferReader, Uint8ArrayReader); + +/** + * @see DataReader.readData + */ +NodeBufferReader.prototype.readData = function(size) { + this.checkOffset(size); + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = NodeBufferReader; + +},{"../utils":32,"./Uint8ArrayReader":21}],20:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function StringReader(data) { + DataReader.call(this, data); +} +utils.inherits(StringReader, DataReader); +/** + * @see DataReader.byteAt + */ +StringReader.prototype.byteAt = function(i) { + return this.data.charCodeAt(this.zero + i); +}; +/** + * @see DataReader.lastIndexOfSignature + */ +StringReader.prototype.lastIndexOfSignature = function(sig) { + return this.data.lastIndexOf(sig) - this.zero; +}; +/** + * @see DataReader.readAndCheckSignature + */ +StringReader.prototype.readAndCheckSignature = function (sig) { + var data = this.readData(4); + return sig === data; +}; +/** + * @see DataReader.readData + */ +StringReader.prototype.readData = function(size) { + this.checkOffset(size); + // this will work because the constructor applied the "& 0xff" mask. + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = StringReader; + +},{"../utils":32,"./DataReader":18}],21:[function(require,module,exports){ +'use strict'; +var ArrayReader = require('./ArrayReader'); +var utils = require('../utils'); + +function Uint8ArrayReader(data) { + ArrayReader.call(this, data); +} +utils.inherits(Uint8ArrayReader, ArrayReader); +/** + * @see DataReader.readData + */ +Uint8ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + // in IE10, when using subarray(idx, idx), we get the array [0x00] instead of []. + return new Uint8Array(0); + } + var result = this.data.subarray(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = Uint8ArrayReader; + +},{"../utils":32,"./ArrayReader":17}],22:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var support = require('../support'); +var ArrayReader = require('./ArrayReader'); +var StringReader = require('./StringReader'); +var NodeBufferReader = require('./NodeBufferReader'); +var Uint8ArrayReader = require('./Uint8ArrayReader'); + +/** + * Create a reader adapted to the data. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data to read. + * @return {DataReader} the data reader. + */ +module.exports = function (data) { + var type = utils.getTypeOf(data); + utils.checkSupport(type); + if (type === "string" && !support.uint8array) { + return new StringReader(data); + } + if (type === "nodebuffer") { + return new NodeBufferReader(data); + } + if (support.uint8array) { + return new Uint8ArrayReader(utils.transformTo("uint8array", data)); + } + return new ArrayReader(utils.transformTo("array", data)); +}; + +},{"../support":30,"../utils":32,"./ArrayReader":17,"./NodeBufferReader":19,"./StringReader":20,"./Uint8ArrayReader":21}],23:[function(require,module,exports){ +'use strict'; +exports.LOCAL_FILE_HEADER = "PK\x03\x04"; +exports.CENTRAL_FILE_HEADER = "PK\x01\x02"; +exports.CENTRAL_DIRECTORY_END = "PK\x05\x06"; +exports.ZIP64_CENTRAL_DIRECTORY_LOCATOR = "PK\x06\x07"; +exports.ZIP64_CENTRAL_DIRECTORY_END = "PK\x06\x06"; +exports.DATA_DESCRIPTOR = "PK\x07\x08"; + +},{}],24:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var utils = require('../utils'); + +/** + * A worker which convert chunks to a specified type. + * @constructor + * @param {String} destType the destination type. + */ +function ConvertWorker(destType) { + GenericWorker.call(this, "ConvertWorker to " + destType); + this.destType = destType; +} +utils.inherits(ConvertWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +ConvertWorker.prototype.processChunk = function (chunk) { + this.push({ + data : utils.transformTo(this.destType, chunk.data), + meta : chunk.meta + }); +}; +module.exports = ConvertWorker; + +},{"../utils":32,"./GenericWorker":28}],25:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var crc32 = require('../crc32'); +var utils = require('../utils'); + +/** + * A worker which calculate the crc32 of the data flowing through. + * @constructor + */ +function Crc32Probe() { + GenericWorker.call(this, "Crc32Probe"); + this.withStreamInfo("crc32", 0); +} +utils.inherits(Crc32Probe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Crc32Probe.prototype.processChunk = function (chunk) { + this.streamInfo.crc32 = crc32(chunk.data, this.streamInfo.crc32 || 0); + this.push(chunk); +}; +module.exports = Crc32Probe; + +},{"../crc32":4,"../utils":32,"./GenericWorker":28}],26:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +/** + * A worker which calculate the total length of the data flowing through. + * @constructor + * @param {String} propName the name used to expose the length + */ +function DataLengthProbe(propName) { + GenericWorker.call(this, "DataLengthProbe for " + propName); + this.propName = propName; + this.withStreamInfo(propName, 0); +} +utils.inherits(DataLengthProbe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +DataLengthProbe.prototype.processChunk = function (chunk) { + if(chunk) { + var length = this.streamInfo[this.propName] || 0; + this.streamInfo[this.propName] = length + chunk.data.length; + } + GenericWorker.prototype.processChunk.call(this, chunk); +}; +module.exports = DataLengthProbe; + + +},{"../utils":32,"./GenericWorker":28}],27:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +// the size of the generated chunks +// TODO expose this as a public variable +var DEFAULT_BLOCK_SIZE = 16 * 1024; + +/** + * A worker that reads a content and emits chunks. + * @constructor + * @param {Promise} dataP the promise of the data to split + */ +function DataWorker(dataP) { + GenericWorker.call(this, "DataWorker"); + var self = this; + this.dataIsReady = false; + this.index = 0; + this.max = 0; + this.data = null; + this.type = ""; + + this._tickScheduled = false; + + dataP.then(function (data) { + self.dataIsReady = true; + self.data = data; + self.max = data && data.length || 0; + self.type = utils.getTypeOf(data); + if(!self.isPaused) { + self._tickAndRepeat(); + } + }, function (e) { + self.error(e); + }); +} + +utils.inherits(DataWorker, GenericWorker); + +/** + * @see GenericWorker.cleanUp + */ +DataWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this.data = null; +}; + +/** + * @see GenericWorker.resume + */ +DataWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this._tickScheduled && this.dataIsReady) { + this._tickScheduled = true; + utils.delay(this._tickAndRepeat, [], this); + } + return true; +}; + +/** + * Trigger a tick a schedule an other call to this function. + */ +DataWorker.prototype._tickAndRepeat = function() { + this._tickScheduled = false; + if(this.isPaused || this.isFinished) { + return; + } + this._tick(); + if(!this.isFinished) { + utils.delay(this._tickAndRepeat, [], this); + this._tickScheduled = true; + } +}; + +/** + * Read and push a chunk. + */ +DataWorker.prototype._tick = function() { + + if(this.isPaused || this.isFinished) { + return false; + } + + var size = DEFAULT_BLOCK_SIZE; + var data = null, nextIndex = Math.min(this.max, this.index + size); + if (this.index >= this.max) { + // EOF + return this.end(); + } else { + switch(this.type) { + case "string": + data = this.data.substring(this.index, nextIndex); + break; + case "uint8array": + data = this.data.subarray(this.index, nextIndex); + break; + case "array": + case "nodebuffer": + data = this.data.slice(this.index, nextIndex); + break; + } + this.index = nextIndex; + return this.push({ + data : data, + meta : { + percent : this.max ? this.index / this.max * 100 : 0 + } + }); + } +}; + +module.exports = DataWorker; + +},{"../utils":32,"./GenericWorker":28}],28:[function(require,module,exports){ +'use strict'; + +/** + * A worker that does nothing but passing chunks to the next one. This is like + * a nodejs stream but with some differences. On the good side : + * - it works on IE 6-9 without any issue / polyfill + * - it weights less than the full dependencies bundled with browserify + * - it forwards errors (no need to declare an error handler EVERYWHERE) + * + * A chunk is an object with 2 attributes : `meta` and `data`. The former is an + * object containing anything (`percent` for example), see each worker for more + * details. The latter is the real data (String, Uint8Array, etc). + * + * @constructor + * @param {String} name the name of the stream (mainly used for debugging purposes) + */ +function GenericWorker(name) { + // the name of the worker + this.name = name || "default"; + // an object containing metadata about the workers chain + this.streamInfo = {}; + // an error which happened when the worker was paused + this.generatedError = null; + // an object containing metadata to be merged by this worker into the general metadata + this.extraStreamInfo = {}; + // true if the stream is paused (and should not do anything), false otherwise + this.isPaused = true; + // true if the stream is finished (and should not do anything), false otherwise + this.isFinished = false; + // true if the stream is locked to prevent further structure updates (pipe), false otherwise + this.isLocked = false; + // the event listeners + this._listeners = { + 'data':[], + 'end':[], + 'error':[] + }; + // the previous worker, if any + this.previous = null; +} + +GenericWorker.prototype = { + /** + * Push a chunk to the next workers. + * @param {Object} chunk the chunk to push + */ + push : function (chunk) { + this.emit("data", chunk); + }, + /** + * End the stream. + * @return {Boolean} true if this call ended the worker, false otherwise. + */ + end : function () { + if (this.isFinished) { + return false; + } + + this.flush(); + try { + this.emit("end"); + this.cleanUp(); + this.isFinished = true; + } catch (e) { + this.emit("error", e); + } + return true; + }, + /** + * End the stream with an error. + * @param {Error} e the error which caused the premature end. + * @return {Boolean} true if this call ended the worker with an error, false otherwise. + */ + error : function (e) { + if (this.isFinished) { + return false; + } + + if(this.isPaused) { + this.generatedError = e; + } else { + this.isFinished = true; + + this.emit("error", e); + + // in the workers chain exploded in the middle of the chain, + // the error event will go downward but we also need to notify + // workers upward that there has been an error. + if(this.previous) { + this.previous.error(e); + } + + this.cleanUp(); + } + return true; + }, + /** + * Add a callback on an event. + * @param {String} name the name of the event (data, end, error) + * @param {Function} listener the function to call when the event is triggered + * @return {GenericWorker} the current object for chainability + */ + on : function (name, listener) { + this._listeners[name].push(listener); + return this; + }, + /** + * Clean any references when a worker is ending. + */ + cleanUp : function () { + this.streamInfo = this.generatedError = this.extraStreamInfo = null; + this._listeners = []; + }, + /** + * Trigger an event. This will call registered callback with the provided arg. + * @param {String} name the name of the event (data, end, error) + * @param {Object} arg the argument to call the callback with. + */ + emit : function (name, arg) { + if (this._listeners[name]) { + for(var i = 0; i < this._listeners[name].length; i++) { + this._listeners[name][i].call(this, arg); + } + } + }, + /** + * Chain a worker with an other. + * @param {Worker} next the worker receiving events from the current one. + * @return {worker} the next worker for chainability + */ + pipe : function (next) { + return next.registerPrevious(this); + }, + /** + * Same as `pipe` in the other direction. + * Using an API with `pipe(next)` is very easy. + * Implementing the API with the point of view of the next one registering + * a source is easier, see the ZipFileWorker. + * @param {Worker} previous the previous worker, sending events to this one + * @return {Worker} the current worker for chainability + */ + registerPrevious : function (previous) { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + + // sharing the streamInfo... + this.streamInfo = previous.streamInfo; + // ... and adding our own bits + this.mergeStreamInfo(); + this.previous = previous; + var self = this; + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.end(); + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; + }, + /** + * Pause the stream so it doesn't send events anymore. + * @return {Boolean} true if this call paused the worker, false otherwise. + */ + pause : function () { + if(this.isPaused || this.isFinished) { + return false; + } + this.isPaused = true; + + if(this.previous) { + this.previous.pause(); + } + return true; + }, + /** + * Resume a paused stream. + * @return {Boolean} true if this call resumed the worker, false otherwise. + */ + resume : function () { + if(!this.isPaused || this.isFinished) { + return false; + } + this.isPaused = false; + + // if true, the worker tried to resume but failed + var withError = false; + if(this.generatedError) { + this.error(this.generatedError); + withError = true; + } + if(this.previous) { + this.previous.resume(); + } + + return !withError; + }, + /** + * Flush any remaining bytes as the stream is ending. + */ + flush : function () {}, + /** + * Process a chunk. This is usually the method overridden. + * @param {Object} chunk the chunk to process. + */ + processChunk : function(chunk) { + this.push(chunk); + }, + /** + * Add a key/value to be added in the workers chain streamInfo once activated. + * @param {String} key the key to use + * @param {Object} value the associated value + * @return {Worker} the current worker for chainability + */ + withStreamInfo : function (key, value) { + this.extraStreamInfo[key] = value; + this.mergeStreamInfo(); + return this; + }, + /** + * Merge this worker's streamInfo into the chain's streamInfo. + */ + mergeStreamInfo : function () { + for(var key in this.extraStreamInfo) { + if (!this.extraStreamInfo.hasOwnProperty(key)) { + continue; + } + this.streamInfo[key] = this.extraStreamInfo[key]; + } + }, + + /** + * Lock the stream to prevent further updates on the workers chain. + * After calling this method, all calls to pipe will fail. + */ + lock: function () { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + this.isLocked = true; + if (this.previous) { + this.previous.lock(); + } + }, + + /** + * + * Pretty print the workers chain. + */ + toString : function () { + var me = "Worker " + this.name; + if (this.previous) { + return this.previous + " -> " + me; + } else { + return me; + } + } +}; + +module.exports = GenericWorker; + +},{}],29:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var ConvertWorker = require('./ConvertWorker'); +var GenericWorker = require('./GenericWorker'); +var base64 = require('../base64'); +var support = require("../support"); +var external = require("../external"); + +var NodejsStreamOutputAdapter = null; +if (support.nodestream) { + try { + NodejsStreamOutputAdapter = require('../nodejs/NodejsStreamOutputAdapter'); + } catch(e) {} +} + +/** + * Apply the final transformation of the data. If the user wants a Blob for + * example, it's easier to work with an U8intArray and finally do the + * ArrayBuffer/Blob conversion. + * @param {String} type the name of the final type + * @param {String|Uint8Array|Buffer} content the content to transform + * @param {String} mimeType the mime type of the content, if applicable. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the content in the right format. + */ +function transformZipOutput(type, content, mimeType) { + switch(type) { + case "blob" : + return utils.newBlob(utils.transformTo("arraybuffer", content), mimeType); + case "base64" : + return base64.encode(content); + default : + return utils.transformTo(type, content); + } +} + +/** + * Concatenate an array of data of the given type. + * @param {String} type the type of the data in the given array. + * @param {Array} dataArray the array containing the data chunks to concatenate + * @return {String|Uint8Array|Buffer} the concatenated data + * @throws Error if the asked type is unsupported + */ +function concat (type, dataArray) { + var i, index = 0, res = null, totalLength = 0; + for(i = 0; i < dataArray.length; i++) { + totalLength += dataArray[i].length; + } + switch(type) { + case "string": + return dataArray.join(""); + case "array": + return Array.prototype.concat.apply([], dataArray); + case "uint8array": + res = new Uint8Array(totalLength); + for(i = 0; i < dataArray.length; i++) { + res.set(dataArray[i], index); + index += dataArray[i].length; + } + return res; + case "nodebuffer": + return Buffer.concat(dataArray); + default: + throw new Error("concat : unsupported type '" + type + "'"); + } +} + +/** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {StreamHelper} helper the helper to use. + * @param {Function} updateCallback a callback called on each update. Called + * with one arg : + * - the metadata linked to the update received. + * @return Promise the promise for the accumulation. + */ +function accumulate(helper, updateCallback) { + return new external.Promise(function (resolve, reject){ + var dataArray = []; + var chunkType = helper._internalType, + resultType = helper._outputType, + mimeType = helper._mimeType; + helper + .on('data', function (data, meta) { + dataArray.push(data); + if(updateCallback) { + updateCallback(meta); + } + }) + .on('error', function(err) { + dataArray = []; + reject(err); + }) + .on('end', function (){ + try { + var result = transformZipOutput(resultType, concat(chunkType, dataArray), mimeType); + resolve(result); + } catch (e) { + reject(e); + } + dataArray = []; + }) + .resume(); + }); +} + +/** + * An helper to easily use workers outside of JSZip. + * @constructor + * @param {Worker} worker the worker to wrap + * @param {String} outputType the type of data expected by the use + * @param {String} mimeType the mime type of the content, if applicable. + */ +function StreamHelper(worker, outputType, mimeType) { + var internalType = outputType; + switch(outputType) { + case "blob": + case "arraybuffer": + internalType = "uint8array"; + break; + case "base64": + internalType = "string"; + break; + } + + try { + // the type used internally + this._internalType = internalType; + // the type used to output results + this._outputType = outputType; + // the mime type + this._mimeType = mimeType; + utils.checkSupport(internalType); + this._worker = worker.pipe(new ConvertWorker(internalType)); + // the last workers can be rewired without issues but we need to + // prevent any updates on previous workers. + worker.lock(); + } catch(e) { + this._worker = new GenericWorker("error"); + this._worker.error(e); + } +} + +StreamHelper.prototype = { + /** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {Function} updateCb the update callback. + * @return Promise the promise for the accumulation. + */ + accumulate : function (updateCb) { + return accumulate(this, updateCb); + }, + /** + * Add a listener on an event triggered on a stream. + * @param {String} evt the name of the event + * @param {Function} fn the listener + * @return {StreamHelper} the current helper. + */ + on : function (evt, fn) { + var self = this; + + if(evt === "data") { + this._worker.on(evt, function (chunk) { + fn.call(self, chunk.data, chunk.meta); + }); + } else { + this._worker.on(evt, function () { + utils.delay(fn, arguments, self); + }); + } + return this; + }, + /** + * Resume the flow of chunks. + * @return {StreamHelper} the current helper. + */ + resume : function () { + utils.delay(this._worker.resume, [], this._worker); + return this; + }, + /** + * Pause the flow of chunks. + * @return {StreamHelper} the current helper. + */ + pause : function () { + this._worker.pause(); + return this; + }, + /** + * Return a nodejs stream for this helper. + * @param {Function} updateCb the update callback. + * @return {NodejsStreamOutputAdapter} the nodejs stream. + */ + toNodejsStream : function (updateCb) { + utils.checkSupport("nodestream"); + if (this._outputType !== "nodebuffer") { + // an object stream containing blob/arraybuffer/uint8array/string + // is strange and I don't know if it would be useful. + // I you find this comment and have a good usecase, please open a + // bug report ! + throw new Error(this._outputType + " is not supported by this method"); + } + + return new NodejsStreamOutputAdapter(this, { + objectMode : this._outputType !== "nodebuffer" + }, updateCb); + } +}; + + +module.exports = StreamHelper; + +},{"../base64":1,"../external":6,"../nodejs/NodejsStreamOutputAdapter":13,"../support":30,"../utils":32,"./ConvertWorker":24,"./GenericWorker":28}],30:[function(require,module,exports){ +'use strict'; + +exports.base64 = true; +exports.array = true; +exports.string = true; +exports.arraybuffer = typeof ArrayBuffer !== "undefined" && typeof Uint8Array !== "undefined"; +exports.nodebuffer = typeof Buffer !== "undefined"; +// contains true if JSZip can read/generate Uint8Array, false otherwise. +exports.uint8array = typeof Uint8Array !== "undefined"; + +if (typeof ArrayBuffer === "undefined") { + exports.blob = false; +} +else { + var buffer = new ArrayBuffer(0); + try { + exports.blob = new Blob([buffer], { + type: "application/zip" + }).size === 0; + } + catch (e) { + try { + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(buffer); + exports.blob = builder.getBlob('application/zip').size === 0; + } + catch (e) { + exports.blob = false; + } + } +} + +try { + exports.nodestream = !!require('readable-stream').Readable; +} catch(e) { + exports.nodestream = false; +} + +},{"readable-stream":16}],31:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); +var support = require('./support'); +var nodejsUtils = require('./nodejsUtils'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * The following functions come from pako, from pako/lib/utils/strings + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Table with utf8 lengths (calculated by first byte of sequence) +// Note, that 5 & 6-byte values and some 4-byte values can not be represented in JS, +// because max possible codepoint is 0x10ffff +var _utf8len = new Array(256); +for (var i=0; i<256; i++) { + _utf8len[i] = (i >= 252 ? 6 : i >= 248 ? 5 : i >= 240 ? 4 : i >= 224 ? 3 : i >= 192 ? 2 : 1); +} +_utf8len[254]=_utf8len[254]=1; // Invalid sequence start + +// convert string to array (typed, when possible) +var string2buf = function (str) { + var buf, c, c2, m_pos, i, str_len = str.length, buf_len = 0; + + // count binary size + for (m_pos = 0; m_pos < str_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + buf_len += c < 0x80 ? 1 : c < 0x800 ? 2 : c < 0x10000 ? 3 : 4; + } + + // allocate buffer + if (support.uint8array) { + buf = new Uint8Array(buf_len); + } else { + buf = new Array(buf_len); + } + + // convert + for (i=0, m_pos = 0; i < buf_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + if (c < 0x80) { + /* one byte */ + buf[i++] = c; + } else if (c < 0x800) { + /* two bytes */ + buf[i++] = 0xC0 | (c >>> 6); + buf[i++] = 0x80 | (c & 0x3f); + } else if (c < 0x10000) { + /* three bytes */ + buf[i++] = 0xE0 | (c >>> 12); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } else { + /* four bytes */ + buf[i++] = 0xf0 | (c >>> 18); + buf[i++] = 0x80 | (c >>> 12 & 0x3f); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } + } + + return buf; +}; + +// Calculate max possible position in utf8 buffer, +// that will not break sequence. If that's not possible +// - (very small limits) return max size as is. +// +// buf[] - utf8 bytes array +// max - length limit (mandatory); +var utf8border = function(buf, max) { + var pos; + + max = max || buf.length; + if (max > buf.length) { max = buf.length; } + + // go back from last position, until start of sequence found + pos = max-1; + while (pos >= 0 && (buf[pos] & 0xC0) === 0x80) { pos--; } + + // Fuckup - very small and broken sequence, + // return max, because we should return something anyway. + if (pos < 0) { return max; } + + // If we came to start of buffer - that means vuffer is too small, + // return max too. + if (pos === 0) { return max; } + + return (pos + _utf8len[buf[pos]] > max) ? pos : max; +}; + +// convert array to string +var buf2string = function (buf) { + var str, i, out, c, c_len; + var len = buf.length; + + // Reserve max possible length (2 words per char) + // NB: by unknown reasons, Array is significantly faster for + // String.fromCharCode.apply than Uint16Array. + var utf16buf = new Array(len*2); + + for (out=0, i=0; i 4) { utf16buf[out++] = 0xfffd; i += c_len-1; continue; } + + // apply mask on first byte + c &= c_len === 2 ? 0x1f : c_len === 3 ? 0x0f : 0x07; + // join the rest + while (c_len > 1 && i < len) { + c = (c << 6) | (buf[i++] & 0x3f); + c_len--; + } + + // terminated by end of string? + if (c_len > 1) { utf16buf[out++] = 0xfffd; continue; } + + if (c < 0x10000) { + utf16buf[out++] = c; + } else { + c -= 0x10000; + utf16buf[out++] = 0xd800 | ((c >> 10) & 0x3ff); + utf16buf[out++] = 0xdc00 | (c & 0x3ff); + } + } + + // shrinkBuf(utf16buf, out) + if (utf16buf.length !== out) { + if(utf16buf.subarray) { + utf16buf = utf16buf.subarray(0, out); + } else { + utf16buf.length = out; + } + } + + // return String.fromCharCode.apply(null, utf16buf); + return utils.applyFromCharCode(utf16buf); +}; + + +// That's all for the pako functions. + + +/** + * Transform a javascript string into an array (typed if possible) of bytes, + * UTF-8 encoded. + * @param {String} str the string to encode + * @return {Array|Uint8Array|Buffer} the UTF-8 encoded string. + */ +exports.utf8encode = function utf8encode(str) { + if (support.nodebuffer) { + return nodejsUtils.newBufferFrom(str, "utf-8"); + } + + return string2buf(str); +}; + + +/** + * Transform a bytes array (or a representation) representing an UTF-8 encoded + * string into a javascript string. + * @param {Array|Uint8Array|Buffer} buf the data de decode + * @return {String} the decoded string. + */ +exports.utf8decode = function utf8decode(buf) { + if (support.nodebuffer) { + return utils.transformTo("nodebuffer", buf).toString("utf-8"); + } + + buf = utils.transformTo(support.uint8array ? "uint8array" : "array", buf); + + return buf2string(buf); +}; + +/** + * A worker to decode utf8 encoded binary chunks into string chunks. + * @constructor + */ +function Utf8DecodeWorker() { + GenericWorker.call(this, "utf-8 decode"); + // the last bytes if a chunk didn't end with a complete codepoint. + this.leftOver = null; +} +utils.inherits(Utf8DecodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8DecodeWorker.prototype.processChunk = function (chunk) { + + var data = utils.transformTo(support.uint8array ? "uint8array" : "array", chunk.data); + + // 1st step, re-use what's left of the previous chunk + if (this.leftOver && this.leftOver.length) { + if(support.uint8array) { + var previousData = data; + data = new Uint8Array(previousData.length + this.leftOver.length); + data.set(this.leftOver, 0); + data.set(previousData, this.leftOver.length); + } else { + data = this.leftOver.concat(data); + } + this.leftOver = null; + } + + var nextBoundary = utf8border(data); + var usableData = data; + if (nextBoundary !== data.length) { + if (support.uint8array) { + usableData = data.subarray(0, nextBoundary); + this.leftOver = data.subarray(nextBoundary, data.length); + } else { + usableData = data.slice(0, nextBoundary); + this.leftOver = data.slice(nextBoundary, data.length); + } + } + + this.push({ + data : exports.utf8decode(usableData), + meta : chunk.meta + }); +}; + +/** + * @see GenericWorker.flush + */ +Utf8DecodeWorker.prototype.flush = function () { + if(this.leftOver && this.leftOver.length) { + this.push({ + data : exports.utf8decode(this.leftOver), + meta : {} + }); + this.leftOver = null; + } +}; +exports.Utf8DecodeWorker = Utf8DecodeWorker; + +/** + * A worker to endcode string chunks into utf8 encoded binary chunks. + * @constructor + */ +function Utf8EncodeWorker() { + GenericWorker.call(this, "utf-8 encode"); +} +utils.inherits(Utf8EncodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8EncodeWorker.prototype.processChunk = function (chunk) { + this.push({ + data : exports.utf8encode(chunk.data), + meta : chunk.meta + }); +}; +exports.Utf8EncodeWorker = Utf8EncodeWorker; + +},{"./nodejsUtils":14,"./stream/GenericWorker":28,"./support":30,"./utils":32}],32:[function(require,module,exports){ +'use strict'; + +var support = require('./support'); +var base64 = require('./base64'); +var nodejsUtils = require('./nodejsUtils'); +var setImmediate = require('core-js/library/fn/set-immediate'); +var external = require("./external"); + + +/** + * Convert a string that pass as a "binary string": it should represent a byte + * array but may have > 255 char codes. Be sure to take only the first byte + * and returns the byte array. + * @param {String} str the string to transform. + * @return {Array|Uint8Array} the string in a binary format. + */ +function string2binary(str) { + var result = null; + if (support.uint8array) { + result = new Uint8Array(str.length); + } else { + result = new Array(str.length); + } + return stringToArrayLike(str, result); +} + +/** + * Create a new blob with the given content and the given type. + * @param {String|ArrayBuffer} part the content to put in the blob. DO NOT use + * an Uint8Array because the stock browser of android 4 won't accept it (it + * will be silently converted to a string, "[object Uint8Array]"). + * + * Use only ONE part to build the blob to avoid a memory leak in IE11 / Edge: + * when a large amount of Array is used to create the Blob, the amount of + * memory consumed is nearly 100 times the original data amount. + * + * @param {String} type the mime type of the blob. + * @return {Blob} the created blob. + */ +exports.newBlob = function(part, type) { + exports.checkSupport("blob"); + + try { + // Blob constructor + return new Blob([part], { + type: type + }); + } + catch (e) { + + try { + // deprecated, browser only, old way + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(part); + return builder.getBlob(type); + } + catch (e) { + + // well, fuck ?! + throw new Error("Bug : can't construct the Blob."); + } + } + + +}; +/** + * The identity function. + * @param {Object} input the input. + * @return {Object} the same input. + */ +function identity(input) { + return input; +} + +/** + * Fill in an array with a string. + * @param {String} str the string to use. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to fill in (will be mutated). + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated array. + */ +function stringToArrayLike(str, array) { + for (var i = 0; i < str.length; ++i) { + array[i] = str.charCodeAt(i) & 0xFF; + } + return array; +} + +/** + * An helper for the function arrayLikeToString. + * This contains static informations and functions that + * can be optimized by the browser JIT compiler. + */ +var arrayToStringHelper = { + /** + * Transform an array of int into a string, chunk by chunk. + * See the performances notes on arrayLikeToString. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @param {String} type the type of the array. + * @param {Integer} chunk the chunk size. + * @return {String} the resulting string. + * @throws Error if the chunk is too big for the stack. + */ + stringifyByChunk: function(array, type, chunk) { + var result = [], k = 0, len = array.length; + // shortcut + if (len <= chunk) { + return String.fromCharCode.apply(null, array); + } + while (k < len) { + if (type === "array" || type === "nodebuffer") { + result.push(String.fromCharCode.apply(null, array.slice(k, Math.min(k + chunk, len)))); + } + else { + result.push(String.fromCharCode.apply(null, array.subarray(k, Math.min(k + chunk, len)))); + } + k += chunk; + } + return result.join(""); + }, + /** + * Call String.fromCharCode on every item in the array. + * This is the naive implementation, which generate A LOT of intermediate string. + * This should be used when everything else fail. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ + stringifyByChar: function(array){ + var resultStr = ""; + for(var i = 0; i < array.length; i++) { + resultStr += String.fromCharCode(array[i]); + } + return resultStr; + }, + applyCanBeUsed : { + /** + * true if the browser accepts to use String.fromCharCode on Uint8Array + */ + uint8array : (function () { + try { + return support.uint8array && String.fromCharCode.apply(null, new Uint8Array(1)).length === 1; + } catch (e) { + return false; + } + })(), + /** + * true if the browser accepts to use String.fromCharCode on nodejs Buffer. + */ + nodebuffer : (function () { + try { + return support.nodebuffer && String.fromCharCode.apply(null, nodejsUtils.allocBuffer(1)).length === 1; + } catch (e) { + return false; + } + })() + } +}; + +/** + * Transform an array-like object to a string. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ +function arrayLikeToString(array) { + // Performances notes : + // -------------------- + // String.fromCharCode.apply(null, array) is the fastest, see + // see http://jsperf.com/converting-a-uint8array-to-a-string/2 + // but the stack is limited (and we can get huge arrays !). + // + // result += String.fromCharCode(array[i]); generate too many strings ! + // + // This code is inspired by http://jsperf.com/arraybuffer-to-string-apply-performance/2 + // TODO : we now have workers that split the work. Do we still need that ? + var chunk = 65536, + type = exports.getTypeOf(array), + canUseApply = true; + if (type === "uint8array") { + canUseApply = arrayToStringHelper.applyCanBeUsed.uint8array; + } else if (type === "nodebuffer") { + canUseApply = arrayToStringHelper.applyCanBeUsed.nodebuffer; + } + + if (canUseApply) { + while (chunk > 1) { + try { + return arrayToStringHelper.stringifyByChunk(array, type, chunk); + } catch (e) { + chunk = Math.floor(chunk / 2); + } + } + } + + // no apply or chunk error : slow and painful algorithm + // default browser on android 4.* + return arrayToStringHelper.stringifyByChar(array); +} + +exports.applyFromCharCode = arrayLikeToString; + + +/** + * Copy the data from an array-like to an other array-like. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayFrom the origin array. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayTo the destination array which will be mutated. + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated destination array. + */ +function arrayLikeToArrayLike(arrayFrom, arrayTo) { + for (var i = 0; i < arrayFrom.length; i++) { + arrayTo[i] = arrayFrom[i]; + } + return arrayTo; +} + +// a matrix containing functions to transform everything into everything. +var transform = {}; + +// string to ? +transform["string"] = { + "string": identity, + "array": function(input) { + return stringToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["string"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return stringToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": function(input) { + return stringToArrayLike(input, nodejsUtils.allocBuffer(input.length)); + } +}; + +// array to ? +transform["array"] = { + "string": arrayLikeToString, + "array": identity, + "arraybuffer": function(input) { + return (new Uint8Array(input)).buffer; + }, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// arraybuffer to ? +transform["arraybuffer"] = { + "string": function(input) { + return arrayLikeToString(new Uint8Array(input)); + }, + "array": function(input) { + return arrayLikeToArrayLike(new Uint8Array(input), new Array(input.byteLength)); + }, + "arraybuffer": identity, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(new Uint8Array(input)); + } +}; + +// uint8array to ? +transform["uint8array"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return input.buffer; + }, + "uint8array": identity, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// nodebuffer to ? +transform["nodebuffer"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["nodebuffer"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return arrayLikeToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": identity +}; + +/** + * Transform an input into any type. + * The supported output type are : string, array, uint8array, arraybuffer, nodebuffer. + * If no output type is specified, the unmodified input will be returned. + * @param {String} outputType the output type. + * @param {String|Array|ArrayBuffer|Uint8Array|Buffer} input the input to convert. + * @throws {Error} an Error if the browser doesn't support the requested output type. + */ +exports.transformTo = function(outputType, input) { + if (!input) { + // undefined, null, etc + // an empty string won't harm. + input = ""; + } + if (!outputType) { + return input; + } + exports.checkSupport(outputType); + var inputType = exports.getTypeOf(input); + var result = transform[inputType][outputType](input); + return result; +}; + +/** + * Return the type of the input. + * The type will be in a format valid for JSZip.utils.transformTo : string, array, uint8array, arraybuffer. + * @param {Object} input the input to identify. + * @return {String} the (lowercase) type of the input. + */ +exports.getTypeOf = function(input) { + if (typeof input === "string") { + return "string"; + } + if (Object.prototype.toString.call(input) === "[object Array]") { + return "array"; + } + if (support.nodebuffer && nodejsUtils.isBuffer(input)) { + return "nodebuffer"; + } + if (support.uint8array && input instanceof Uint8Array) { + return "uint8array"; + } + if (support.arraybuffer && input instanceof ArrayBuffer) { + return "arraybuffer"; + } +}; + +/** + * Throw an exception if the type is not supported. + * @param {String} type the type to check. + * @throws {Error} an Error if the browser doesn't support the requested type. + */ +exports.checkSupport = function(type) { + var supported = support[type.toLowerCase()]; + if (!supported) { + throw new Error(type + " is not supported by this platform"); + } +}; + +exports.MAX_VALUE_16BITS = 65535; +exports.MAX_VALUE_32BITS = -1; // well, "\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF" is parsed as -1 + +/** + * Prettify a string read as binary. + * @param {string} str the string to prettify. + * @return {string} a pretty string. + */ +exports.pretty = function(str) { + var res = '', + code, i; + for (i = 0; i < (str || "").length; i++) { + code = str.charCodeAt(i); + res += '\\x' + (code < 16 ? "0" : "") + code.toString(16).toUpperCase(); + } + return res; +}; + +/** + * Defer the call of a function. + * @param {Function} callback the function to call asynchronously. + * @param {Array} args the arguments to give to the callback. + */ +exports.delay = function(callback, args, self) { + setImmediate(function () { + callback.apply(self || null, args || []); + }); +}; + +/** + * Extends a prototype with an other, without calling a constructor with + * side effects. Inspired by nodejs' `utils.inherits` + * @param {Function} ctor the constructor to augment + * @param {Function} superCtor the parent constructor to use + */ +exports.inherits = function (ctor, superCtor) { + var Obj = function() {}; + Obj.prototype = superCtor.prototype; + ctor.prototype = new Obj(); +}; + +/** + * Merge the objects passed as parameters into a new one. + * @private + * @param {...Object} var_args All objects to merge. + * @return {Object} a new object with the data of the others. + */ +exports.extend = function() { + var result = {}, i, attr; + for (i = 0; i < arguments.length; i++) { // arguments is not enumerable in some browsers + for (attr in arguments[i]) { + if (arguments[i].hasOwnProperty(attr) && typeof result[attr] === "undefined") { + result[attr] = arguments[i][attr]; + } + } + } + return result; +}; + +/** + * Transform arbitrary content into a Promise. + * @param {String} name a name for the content being processed. + * @param {Object} inputData the content to process. + * @param {Boolean} isBinary true if the content is not an unicode string + * @param {Boolean} isOptimizedBinaryString true if the string content only has one byte per character. + * @param {Boolean} isBase64 true if the string content is encoded with base64. + * @return {Promise} a promise in a format usable by JSZip. + */ +exports.prepareContent = function(name, inputData, isBinary, isOptimizedBinaryString, isBase64) { + + // if inputData is already a promise, this flatten it. + var promise = external.Promise.resolve(inputData).then(function(data) { + + + var isBlob = support.blob && (data instanceof Blob || ['[object File]', '[object Blob]'].indexOf(Object.prototype.toString.call(data)) !== -1); + + if (isBlob && typeof FileReader !== "undefined") { + return new external.Promise(function (resolve, reject) { + var reader = new FileReader(); + + reader.onload = function(e) { + resolve(e.target.result); + }; + reader.onerror = function(e) { + reject(e.target.error); + }; + reader.readAsArrayBuffer(data); + }); + } else { + return data; + } + }); + + return promise.then(function(data) { + var dataType = exports.getTypeOf(data); + + if (!dataType) { + return external.Promise.reject( + new Error("Can't read the data of '" + name + "'. Is it " + + "in a supported JavaScript type (String, Blob, ArrayBuffer, etc) ?") + ); + } + // special case : it's way easier to work with Uint8Array than with ArrayBuffer + if (dataType === "arraybuffer") { + data = exports.transformTo("uint8array", data); + } else if (dataType === "string") { + if (isBase64) { + data = base64.decode(data); + } + else if (isBinary) { + // optimizedBinaryString === true means that the file has already been filtered with a 0xFF mask + if (isOptimizedBinaryString !== true) { + // this is a string, not in a base64 format. + // Be sure that this is a correct "binary string" + data = string2binary(data); + } + } + } + return data; + }); +}; + +},{"./base64":1,"./external":6,"./nodejsUtils":14,"./support":30,"core-js/library/fn/set-immediate":36}],33:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var sig = require('./signature'); +var ZipEntry = require('./zipEntry'); +var utf8 = require('./utf8'); +var support = require('./support'); +// class ZipEntries {{{ +/** + * All the entries in the zip file. + * @constructor + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntries(loadOptions) { + this.files = []; + this.loadOptions = loadOptions; +} +ZipEntries.prototype = { + /** + * Check that the reader is on the specified signature. + * @param {string} expectedSignature the expected signature. + * @throws {Error} if it is an other signature. + */ + checkSignature: function(expectedSignature) { + if (!this.reader.readAndCheckSignature(expectedSignature)) { + this.reader.index -= 4; + var signature = this.reader.readString(4); + throw new Error("Corrupted zip or bug: unexpected signature " + "(" + utils.pretty(signature) + ", expected " + utils.pretty(expectedSignature) + ")"); + } + }, + /** + * Check if the given signature is at the given index. + * @param {number} askedIndex the index to check. + * @param {string} expectedSignature the signature to expect. + * @return {boolean} true if the signature is here, false otherwise. + */ + isSignature: function(askedIndex, expectedSignature) { + var currentIndex = this.reader.index; + this.reader.setIndex(askedIndex); + var signature = this.reader.readString(4); + var result = signature === expectedSignature; + this.reader.setIndex(currentIndex); + return result; + }, + /** + * Read the end of the central directory. + */ + readBlockEndOfCentral: function() { + this.diskNumber = this.reader.readInt(2); + this.diskWithCentralDirStart = this.reader.readInt(2); + this.centralDirRecordsOnThisDisk = this.reader.readInt(2); + this.centralDirRecords = this.reader.readInt(2); + this.centralDirSize = this.reader.readInt(4); + this.centralDirOffset = this.reader.readInt(4); + + this.zipCommentLength = this.reader.readInt(2); + // warning : the encoding depends of the system locale + // On a linux machine with LANG=en_US.utf8, this field is utf8 encoded. + // On a windows machine, this field is encoded with the localized windows code page. + var zipComment = this.reader.readData(this.zipCommentLength); + var decodeParamType = support.uint8array ? "uint8array" : "array"; + // To get consistent behavior with the generation part, we will assume that + // this is utf8 encoded unless specified otherwise. + var decodeContent = utils.transformTo(decodeParamType, zipComment); + this.zipComment = this.loadOptions.decodeFileName(decodeContent); + }, + /** + * Read the end of the Zip 64 central directory. + * Not merged with the method readEndOfCentral : + * The end of central can coexist with its Zip64 brother, + * I don't want to read the wrong number of bytes ! + */ + readBlockZip64EndOfCentral: function() { + this.zip64EndOfCentralSize = this.reader.readInt(8); + this.reader.skip(4); + // this.versionMadeBy = this.reader.readString(2); + // this.versionNeeded = this.reader.readInt(2); + this.diskNumber = this.reader.readInt(4); + this.diskWithCentralDirStart = this.reader.readInt(4); + this.centralDirRecordsOnThisDisk = this.reader.readInt(8); + this.centralDirRecords = this.reader.readInt(8); + this.centralDirSize = this.reader.readInt(8); + this.centralDirOffset = this.reader.readInt(8); + + this.zip64ExtensibleData = {}; + var extraDataSize = this.zip64EndOfCentralSize - 44, + index = 0, + extraFieldId, + extraFieldLength, + extraFieldValue; + while (index < extraDataSize) { + extraFieldId = this.reader.readInt(2); + extraFieldLength = this.reader.readInt(4); + extraFieldValue = this.reader.readData(extraFieldLength); + this.zip64ExtensibleData[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + }, + /** + * Read the end of the Zip 64 central directory locator. + */ + readBlockZip64EndOfCentralLocator: function() { + this.diskWithZip64CentralDirStart = this.reader.readInt(4); + this.relativeOffsetEndOfZip64CentralDir = this.reader.readInt(8); + this.disksCount = this.reader.readInt(4); + if (this.disksCount > 1) { + throw new Error("Multi-volumes zip are not supported"); + } + }, + /** + * Read the local files, based on the offset read in the central part. + */ + readLocalFiles: function() { + var i, file; + for (i = 0; i < this.files.length; i++) { + file = this.files[i]; + this.reader.setIndex(file.localHeaderOffset); + this.checkSignature(sig.LOCAL_FILE_HEADER); + file.readLocalPart(this.reader); + file.handleUTF8(); + file.processAttributes(); + } + }, + /** + * Read the central directory. + */ + readCentralDir: function() { + var file; + + this.reader.setIndex(this.centralDirOffset); + while (this.reader.readAndCheckSignature(sig.CENTRAL_FILE_HEADER)) { + file = new ZipEntry({ + zip64: this.zip64 + }, this.loadOptions); + file.readCentralPart(this.reader); + this.files.push(file); + } + + if (this.centralDirRecords !== this.files.length) { + if (this.centralDirRecords !== 0 && this.files.length === 0) { + // We expected some records but couldn't find ANY. + // This is really suspicious, as if something went wrong. + throw new Error("Corrupted zip or bug: expected " + this.centralDirRecords + " records in central dir, got " + this.files.length); + } else { + // We found some records but not all. + // Something is wrong but we got something for the user: no error here. + // console.warn("expected", this.centralDirRecords, "records in central dir, got", this.files.length); + } + } + }, + /** + * Read the end of central directory. + */ + readEndOfCentral: function() { + var offset = this.reader.lastIndexOfSignature(sig.CENTRAL_DIRECTORY_END); + if (offset < 0) { + // Check if the content is a truncated zip or complete garbage. + // A "LOCAL_FILE_HEADER" is not required at the beginning (auto + // extractible zip for example) but it can give a good hint. + // If an ajax request was used without responseType, we will also + // get unreadable data. + var isGarbage = !this.isSignature(0, sig.LOCAL_FILE_HEADER); + + if (isGarbage) { + throw new Error("Can't find end of central directory : is this a zip file ? " + + "If it is, see https://stuk.github.io/jszip/documentation/howto/read_zip.html"); + } else { + throw new Error("Corrupted zip: can't find end of central directory"); + } + + } + this.reader.setIndex(offset); + var endOfCentralDirOffset = offset; + this.checkSignature(sig.CENTRAL_DIRECTORY_END); + this.readBlockEndOfCentral(); + + + /* extract from the zip spec : + 4) If one of the fields in the end of central directory + record is too small to hold required data, the field + should be set to -1 (0xFFFF or 0xFFFFFFFF) and the + ZIP64 format record should be created. + 5) The end of central directory record and the + Zip64 end of central directory locator record must + reside on the same disk when splitting or spanning + an archive. + */ + if (this.diskNumber === utils.MAX_VALUE_16BITS || this.diskWithCentralDirStart === utils.MAX_VALUE_16BITS || this.centralDirRecordsOnThisDisk === utils.MAX_VALUE_16BITS || this.centralDirRecords === utils.MAX_VALUE_16BITS || this.centralDirSize === utils.MAX_VALUE_32BITS || this.centralDirOffset === utils.MAX_VALUE_32BITS) { + this.zip64 = true; + + /* + Warning : the zip64 extension is supported, but ONLY if the 64bits integer read from + the zip file can fit into a 32bits integer. This cannot be solved : JavaScript represents + all numbers as 64-bit double precision IEEE 754 floating point numbers. + So, we have 53bits for integers and bitwise operations treat everything as 32bits. + see https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Operators/Bitwise_Operators + and http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-262.pdf section 8.5 + */ + + // should look for a zip64 EOCD locator + offset = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + if (offset < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory locator"); + } + this.reader.setIndex(offset); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + this.readBlockZip64EndOfCentralLocator(); + + // now the zip64 EOCD record + if (!this.isSignature(this.relativeOffsetEndOfZip64CentralDir, sig.ZIP64_CENTRAL_DIRECTORY_END)) { + // console.warn("ZIP64 end of central directory not where expected."); + this.relativeOffsetEndOfZip64CentralDir = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + if (this.relativeOffsetEndOfZip64CentralDir < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory"); + } + } + this.reader.setIndex(this.relativeOffsetEndOfZip64CentralDir); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + this.readBlockZip64EndOfCentral(); + } + + var expectedEndOfCentralDirOffset = this.centralDirOffset + this.centralDirSize; + if (this.zip64) { + expectedEndOfCentralDirOffset += 20; // end of central dir 64 locator + expectedEndOfCentralDirOffset += 12 /* should not include the leading 12 bytes */ + this.zip64EndOfCentralSize; + } + + var extraBytes = endOfCentralDirOffset - expectedEndOfCentralDirOffset; + + if (extraBytes > 0) { + // console.warn(extraBytes, "extra bytes at beginning or within zipfile"); + if (this.isSignature(endOfCentralDirOffset, sig.CENTRAL_FILE_HEADER)) { + // The offsets seem wrong, but we have something at the specified offset. + // So… we keep it. + } else { + // the offset is wrong, update the "zero" of the reader + // this happens if data has been prepended (crx files for example) + this.reader.zero = extraBytes; + } + } else if (extraBytes < 0) { + throw new Error("Corrupted zip: missing " + Math.abs(extraBytes) + " bytes."); + } + }, + prepareReader: function(data) { + this.reader = readerFor(data); + }, + /** + * Read a zip file and create ZipEntries. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the binary string representing a zip file. + */ + load: function(data) { + this.prepareReader(data); + this.readEndOfCentral(); + this.readCentralDir(); + this.readLocalFiles(); + } +}; +// }}} end of ZipEntries +module.exports = ZipEntries; + +},{"./reader/readerFor":22,"./signature":23,"./support":30,"./utf8":31,"./utils":32,"./zipEntry":34}],34:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var CompressedObject = require('./compressedObject'); +var crc32fn = require('./crc32'); +var utf8 = require('./utf8'); +var compressions = require('./compressions'); +var support = require('./support'); + +var MADE_BY_DOS = 0x00; +var MADE_BY_UNIX = 0x03; + +/** + * Find a compression registered in JSZip. + * @param {string} compressionMethod the method magic to find. + * @return {Object|null} the JSZip compression object, null if none found. + */ +var findCompression = function(compressionMethod) { + for (var method in compressions) { + if (!compressions.hasOwnProperty(method)) { + continue; + } + if (compressions[method].magic === compressionMethod) { + return compressions[method]; + } + } + return null; +}; + +// class ZipEntry {{{ +/** + * An entry in the zip file. + * @constructor + * @param {Object} options Options of the current file. + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntry(options, loadOptions) { + this.options = options; + this.loadOptions = loadOptions; +} +ZipEntry.prototype = { + /** + * say if the file is encrypted. + * @return {boolean} true if the file is encrypted, false otherwise. + */ + isEncrypted: function() { + // bit 1 is set + return (this.bitFlag & 0x0001) === 0x0001; + }, + /** + * say if the file has utf-8 filename/comment. + * @return {boolean} true if the filename/comment is in utf-8, false otherwise. + */ + useUTF8: function() { + // bit 11 is set + return (this.bitFlag & 0x0800) === 0x0800; + }, + /** + * Read the local part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readLocalPart: function(reader) { + var compression, localExtraFieldsLength; + + // we already know everything from the central dir ! + // If the central dir data are false, we are doomed. + // On the bright side, the local part is scary : zip64, data descriptors, both, etc. + // The less data we get here, the more reliable this should be. + // Let's skip the whole header and dash to the data ! + reader.skip(22); + // in some zip created on windows, the filename stored in the central dir contains \ instead of /. + // Strangely, the filename here is OK. + // I would love to treat these zip files as corrupted (see http://www.info-zip.org/FAQ.html#backslashes + // or APPNOTE#4.4.17.1, "All slashes MUST be forward slashes '/'") but there are a lot of bad zip generators... + // Search "unzip mismatching "local" filename continuing with "central" filename version" on + // the internet. + // + // I think I see the logic here : the central directory is used to display + // content and the local directory is used to extract the files. Mixing / and \ + // may be used to display \ to windows users and use / when extracting the files. + // Unfortunately, this lead also to some issues : http://seclists.org/fulldisclosure/2009/Sep/394 + this.fileNameLength = reader.readInt(2); + localExtraFieldsLength = reader.readInt(2); // can't be sure this will be the same as the central dir + // the fileName is stored as binary data, the handleUTF8 method will take care of the encoding. + this.fileName = reader.readData(this.fileNameLength); + reader.skip(localExtraFieldsLength); + + if (this.compressedSize === -1 || this.uncompressedSize === -1) { + throw new Error("Bug or corrupted zip : didn't get enough informations from the central directory " + "(compressedSize === -1 || uncompressedSize === -1)"); + } + + compression = findCompression(this.compressionMethod); + if (compression === null) { // no compression found + throw new Error("Corrupted zip : compression " + utils.pretty(this.compressionMethod) + " unknown (inner file : " + utils.transformTo("string", this.fileName) + ")"); + } + this.decompressed = new CompressedObject(this.compressedSize, this.uncompressedSize, this.crc32, compression, reader.readData(this.compressedSize)); + }, + + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readCentralPart: function(reader) { + this.versionMadeBy = reader.readInt(2); + reader.skip(2); + // this.versionNeeded = reader.readInt(2); + this.bitFlag = reader.readInt(2); + this.compressionMethod = reader.readString(2); + this.date = reader.readDate(); + this.crc32 = reader.readInt(4); + this.compressedSize = reader.readInt(4); + this.uncompressedSize = reader.readInt(4); + var fileNameLength = reader.readInt(2); + this.extraFieldsLength = reader.readInt(2); + this.fileCommentLength = reader.readInt(2); + this.diskNumberStart = reader.readInt(2); + this.internalFileAttributes = reader.readInt(2); + this.externalFileAttributes = reader.readInt(4); + this.localHeaderOffset = reader.readInt(4); + + if (this.isEncrypted()) { + throw new Error("Encrypted zip are not supported"); + } + + // will be read in the local part, see the comments there + reader.skip(fileNameLength); + this.readExtraFields(reader); + this.parseZIP64ExtraField(reader); + this.fileComment = reader.readData(this.fileCommentLength); + }, + + /** + * Parse the external file attributes and get the unix/dos permissions. + */ + processAttributes: function () { + this.unixPermissions = null; + this.dosPermissions = null; + var madeBy = this.versionMadeBy >> 8; + + // Check if we have the DOS directory flag set. + // We look for it in the DOS and UNIX permissions + // but some unknown platform could set it as a compatibility flag. + this.dir = this.externalFileAttributes & 0x0010 ? true : false; + + if(madeBy === MADE_BY_DOS) { + // first 6 bits (0 to 5) + this.dosPermissions = this.externalFileAttributes & 0x3F; + } + + if(madeBy === MADE_BY_UNIX) { + this.unixPermissions = (this.externalFileAttributes >> 16) & 0xFFFF; + // the octal permissions are in (this.unixPermissions & 0x01FF).toString(8); + } + + // fail safe : if the name ends with a / it probably means a folder + if (!this.dir && this.fileNameStr.slice(-1) === '/') { + this.dir = true; + } + }, + + /** + * Parse the ZIP64 extra field and merge the info in the current ZipEntry. + * @param {DataReader} reader the reader to use. + */ + parseZIP64ExtraField: function(reader) { + + if (!this.extraFields[0x0001]) { + return; + } + + // should be something, preparing the extra reader + var extraReader = readerFor(this.extraFields[0x0001].value); + + // I really hope that these 64bits integer can fit in 32 bits integer, because js + // won't let us have more. + if (this.uncompressedSize === utils.MAX_VALUE_32BITS) { + this.uncompressedSize = extraReader.readInt(8); + } + if (this.compressedSize === utils.MAX_VALUE_32BITS) { + this.compressedSize = extraReader.readInt(8); + } + if (this.localHeaderOffset === utils.MAX_VALUE_32BITS) { + this.localHeaderOffset = extraReader.readInt(8); + } + if (this.diskNumberStart === utils.MAX_VALUE_32BITS) { + this.diskNumberStart = extraReader.readInt(4); + } + }, + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readExtraFields: function(reader) { + var end = reader.index + this.extraFieldsLength, + extraFieldId, + extraFieldLength, + extraFieldValue; + + if (!this.extraFields) { + this.extraFields = {}; + } + + while (reader.index < end) { + extraFieldId = reader.readInt(2); + extraFieldLength = reader.readInt(2); + extraFieldValue = reader.readData(extraFieldLength); + + this.extraFields[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + }, + /** + * Apply an UTF8 transformation if needed. + */ + handleUTF8: function() { + var decodeParamType = support.uint8array ? "uint8array" : "array"; + if (this.useUTF8()) { + this.fileNameStr = utf8.utf8decode(this.fileName); + this.fileCommentStr = utf8.utf8decode(this.fileComment); + } else { + var upath = this.findExtraFieldUnicodePath(); + if (upath !== null) { + this.fileNameStr = upath; + } else { + // ASCII text or unsupported code page + var fileNameByteArray = utils.transformTo(decodeParamType, this.fileName); + this.fileNameStr = this.loadOptions.decodeFileName(fileNameByteArray); + } + + var ucomment = this.findExtraFieldUnicodeComment(); + if (ucomment !== null) { + this.fileCommentStr = ucomment; + } else { + // ASCII text or unsupported code page + var commentByteArray = utils.transformTo(decodeParamType, this.fileComment); + this.fileCommentStr = this.loadOptions.decodeFileName(commentByteArray); + } + } + }, + + /** + * Find the unicode path declared in the extra field, if any. + * @return {String} the unicode path, null otherwise. + */ + findExtraFieldUnicodePath: function() { + var upathField = this.extraFields[0x7075]; + if (upathField) { + var extraReader = readerFor(upathField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the filename changed, this field is out of date. + if (crc32fn(this.fileName) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(upathField.length - 5)); + } + return null; + }, + + /** + * Find the unicode comment declared in the extra field, if any. + * @return {String} the unicode comment, null otherwise. + */ + findExtraFieldUnicodeComment: function() { + var ucommentField = this.extraFields[0x6375]; + if (ucommentField) { + var extraReader = readerFor(ucommentField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the comment changed, this field is out of date. + if (crc32fn(this.fileComment) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(ucommentField.length - 5)); + } + return null; + } +}; +module.exports = ZipEntry; + +},{"./compressedObject":2,"./compressions":3,"./crc32":4,"./reader/readerFor":22,"./support":30,"./utf8":31,"./utils":32}],35:[function(require,module,exports){ +'use strict'; + +var StreamHelper = require('./stream/StreamHelper'); +var DataWorker = require('./stream/DataWorker'); +var utf8 = require('./utf8'); +var CompressedObject = require('./compressedObject'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * A simple object representing a file in the zip file. + * @constructor + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data + * @param {Object} options the options of the file + */ +var ZipObject = function(name, data, options) { + this.name = name; + this.dir = options.dir; + this.date = options.date; + this.comment = options.comment; + this.unixPermissions = options.unixPermissions; + this.dosPermissions = options.dosPermissions; + + this._data = data; + this._dataBinary = options.binary; + // keep only the compression + this.options = { + compression : options.compression, + compressionOptions : options.compressionOptions + }; +}; + +ZipObject.prototype = { + /** + * Create an internal stream for the content of this object. + * @param {String} type the type of each chunk. + * @return StreamHelper the stream. + */ + internalStream: function (type) { + var result = null, outputType = "string"; + try { + if (!type) { + throw new Error("No output type specified."); + } + outputType = type.toLowerCase(); + var askUnicodeString = outputType === "string" || outputType === "text"; + if (outputType === "binarystring" || outputType === "text") { + outputType = "string"; + } + result = this._decompressWorker(); + + var isUnicodeString = !this._dataBinary; + + if (isUnicodeString && !askUnicodeString) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + if (!isUnicodeString && askUnicodeString) { + result = result.pipe(new utf8.Utf8DecodeWorker()); + } + } catch (e) { + result = new GenericWorker("error"); + result.error(e); + } + + return new StreamHelper(result, outputType, ""); + }, + + /** + * Prepare the content in the asked type. + * @param {String} type the type of the result. + * @param {Function} onUpdate a function to call on each internal update. + * @return Promise the promise of the result. + */ + async: function (type, onUpdate) { + return this.internalStream(type).accumulate(onUpdate); + }, + + /** + * Prepare the content as a nodejs stream. + * @param {String} type the type of each chunk. + * @param {Function} onUpdate a function to call on each internal update. + * @return Stream the stream. + */ + nodeStream: function (type, onUpdate) { + return this.internalStream(type || "nodebuffer").toNodejsStream(onUpdate); + }, + + /** + * Return a worker for the compressed content. + * @private + * @param {Object} compression the compression object to use. + * @param {Object} compressionOptions the options to use when compressing. + * @return Worker the worker. + */ + _compressWorker: function (compression, compressionOptions) { + if ( + this._data instanceof CompressedObject && + this._data.compression.magic === compression.magic + ) { + return this._data.getCompressedWorker(); + } else { + var result = this._decompressWorker(); + if(!this._dataBinary) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + return CompressedObject.createWorkerFrom(result, compression, compressionOptions); + } + }, + /** + * Return a worker for the decompressed content. + * @private + * @return Worker the worker. + */ + _decompressWorker : function () { + if (this._data instanceof CompressedObject) { + return this._data.getContentWorker(); + } else if (this._data instanceof GenericWorker) { + return this._data; + } else { + return new DataWorker(this._data); + } + } +}; + +var removedMethods = ["asText", "asBinary", "asNodeBuffer", "asUint8Array", "asArrayBuffer"]; +var removedFn = function () { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); +}; + +for(var i = 0; i < removedMethods.length; i++) { + ZipObject.prototype[removedMethods[i]] = removedFn; +} +module.exports = ZipObject; + +},{"./compressedObject":2,"./stream/DataWorker":27,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31}],36:[function(require,module,exports){ +require('../modules/web.immediate'); +module.exports = require('../modules/_core').setImmediate; +},{"../modules/_core":40,"../modules/web.immediate":56}],37:[function(require,module,exports){ +module.exports = function(it){ + if(typeof it != 'function')throw TypeError(it + ' is not a function!'); + return it; +}; +},{}],38:[function(require,module,exports){ +var isObject = require('./_is-object'); +module.exports = function(it){ + if(!isObject(it))throw TypeError(it + ' is not an object!'); + return it; +}; +},{"./_is-object":51}],39:[function(require,module,exports){ +var toString = {}.toString; + +module.exports = function(it){ + return toString.call(it).slice(8, -1); +}; +},{}],40:[function(require,module,exports){ +var core = module.exports = {version: '2.3.0'}; +if(typeof __e == 'number')__e = core; // eslint-disable-line no-undef +},{}],41:[function(require,module,exports){ +// optional / simple context binding +var aFunction = require('./_a-function'); +module.exports = function(fn, that, length){ + aFunction(fn); + if(that === undefined)return fn; + switch(length){ + case 1: return function(a){ + return fn.call(that, a); + }; + case 2: return function(a, b){ + return fn.call(that, a, b); + }; + case 3: return function(a, b, c){ + return fn.call(that, a, b, c); + }; + } + return function(/* ...args */){ + return fn.apply(that, arguments); + }; +}; +},{"./_a-function":37}],42:[function(require,module,exports){ +// Thank's IE8 for his funny defineProperty +module.exports = !require('./_fails')(function(){ + return Object.defineProperty({}, 'a', {get: function(){ return 7; }}).a != 7; +}); +},{"./_fails":45}],43:[function(require,module,exports){ +var isObject = require('./_is-object') + , document = require('./_global').document + // in old IE typeof document.createElement is 'object' + , is = isObject(document) && isObject(document.createElement); +module.exports = function(it){ + return is ? document.createElement(it) : {}; +}; +},{"./_global":46,"./_is-object":51}],44:[function(require,module,exports){ +var global = require('./_global') + , core = require('./_core') + , ctx = require('./_ctx') + , hide = require('./_hide') + , PROTOTYPE = 'prototype'; + +var $export = function(type, name, source){ + var IS_FORCED = type & $export.F + , IS_GLOBAL = type & $export.G + , IS_STATIC = type & $export.S + , IS_PROTO = type & $export.P + , IS_BIND = type & $export.B + , IS_WRAP = type & $export.W + , exports = IS_GLOBAL ? core : core[name] || (core[name] = {}) + , expProto = exports[PROTOTYPE] + , target = IS_GLOBAL ? global : IS_STATIC ? global[name] : (global[name] || {})[PROTOTYPE] + , key, own, out; + if(IS_GLOBAL)source = name; + for(key in source){ + // contains in native + own = !IS_FORCED && target && target[key] !== undefined; + if(own && key in exports)continue; + // export native or passed + out = own ? target[key] : source[key]; + // prevent global pollution for namespaces + exports[key] = IS_GLOBAL && typeof target[key] != 'function' ? source[key] + // bind timers to global for call from export context + : IS_BIND && own ? ctx(out, global) + // wrap global constructors for prevent change them in library + : IS_WRAP && target[key] == out ? (function(C){ + var F = function(a, b, c){ + if(this instanceof C){ + switch(arguments.length){ + case 0: return new C; + case 1: return new C(a); + case 2: return new C(a, b); + } return new C(a, b, c); + } return C.apply(this, arguments); + }; + F[PROTOTYPE] = C[PROTOTYPE]; + return F; + // make static versions for prototype methods + })(out) : IS_PROTO && typeof out == 'function' ? ctx(Function.call, out) : out; + // export proto methods to core.%CONSTRUCTOR%.methods.%NAME% + if(IS_PROTO){ + (exports.virtual || (exports.virtual = {}))[key] = out; + // export proto methods to core.%CONSTRUCTOR%.prototype.%NAME% + if(type & $export.R && expProto && !expProto[key])hide(expProto, key, out); + } + } +}; +// type bitmap +$export.F = 1; // forced +$export.G = 2; // global +$export.S = 4; // static +$export.P = 8; // proto +$export.B = 16; // bind +$export.W = 32; // wrap +$export.U = 64; // safe +$export.R = 128; // real proto method for `library` +module.exports = $export; +},{"./_core":40,"./_ctx":41,"./_global":46,"./_hide":47}],45:[function(require,module,exports){ +module.exports = function(exec){ + try { + return !!exec(); + } catch(e){ + return true; + } +}; +},{}],46:[function(require,module,exports){ +// https://github.com/zloirock/core-js/issues/86#issuecomment-115759028 +var global = module.exports = typeof window != 'undefined' && window.Math == Math + ? window : typeof self != 'undefined' && self.Math == Math ? self : Function('return this')(); +if(typeof __g == 'number')__g = global; // eslint-disable-line no-undef +},{}],47:[function(require,module,exports){ +var dP = require('./_object-dp') + , createDesc = require('./_property-desc'); +module.exports = require('./_descriptors') ? function(object, key, value){ + return dP.f(object, key, createDesc(1, value)); +} : function(object, key, value){ + object[key] = value; + return object; +}; +},{"./_descriptors":42,"./_object-dp":52,"./_property-desc":53}],48:[function(require,module,exports){ +module.exports = require('./_global').document && document.documentElement; +},{"./_global":46}],49:[function(require,module,exports){ +module.exports = !require('./_descriptors') && !require('./_fails')(function(){ + return Object.defineProperty(require('./_dom-create')('div'), 'a', {get: function(){ return 7; }}).a != 7; +}); +},{"./_descriptors":42,"./_dom-create":43,"./_fails":45}],50:[function(require,module,exports){ +// fast apply, http://jsperf.lnkit.com/fast-apply/5 +module.exports = function(fn, args, that){ + var un = that === undefined; + switch(args.length){ + case 0: return un ? fn() + : fn.call(that); + case 1: return un ? fn(args[0]) + : fn.call(that, args[0]); + case 2: return un ? fn(args[0], args[1]) + : fn.call(that, args[0], args[1]); + case 3: return un ? fn(args[0], args[1], args[2]) + : fn.call(that, args[0], args[1], args[2]); + case 4: return un ? fn(args[0], args[1], args[2], args[3]) + : fn.call(that, args[0], args[1], args[2], args[3]); + } return fn.apply(that, args); +}; +},{}],51:[function(require,module,exports){ +module.exports = function(it){ + return typeof it === 'object' ? it !== null : typeof it === 'function'; +}; +},{}],52:[function(require,module,exports){ +var anObject = require('./_an-object') + , IE8_DOM_DEFINE = require('./_ie8-dom-define') + , toPrimitive = require('./_to-primitive') + , dP = Object.defineProperty; + +exports.f = require('./_descriptors') ? Object.defineProperty : function defineProperty(O, P, Attributes){ + anObject(O); + P = toPrimitive(P, true); + anObject(Attributes); + if(IE8_DOM_DEFINE)try { + return dP(O, P, Attributes); + } catch(e){ /* empty */ } + if('get' in Attributes || 'set' in Attributes)throw TypeError('Accessors not supported!'); + if('value' in Attributes)O[P] = Attributes.value; + return O; +}; +},{"./_an-object":38,"./_descriptors":42,"./_ie8-dom-define":49,"./_to-primitive":55}],53:[function(require,module,exports){ +module.exports = function(bitmap, value){ + return { + enumerable : !(bitmap & 1), + configurable: !(bitmap & 2), + writable : !(bitmap & 4), + value : value + }; +}; +},{}],54:[function(require,module,exports){ +var ctx = require('./_ctx') + , invoke = require('./_invoke') + , html = require('./_html') + , cel = require('./_dom-create') + , global = require('./_global') + , process = global.process + , setTask = global.setImmediate + , clearTask = global.clearImmediate + , MessageChannel = global.MessageChannel + , counter = 0 + , queue = {} + , ONREADYSTATECHANGE = 'onreadystatechange' + , defer, channel, port; +var run = function(){ + var id = +this; + if(queue.hasOwnProperty(id)){ + var fn = queue[id]; + delete queue[id]; + fn(); + } +}; +var listener = function(event){ + run.call(event.data); +}; +// Node.js 0.9+ & IE10+ has setImmediate, otherwise: +if(!setTask || !clearTask){ + setTask = function setImmediate(fn){ + var args = [], i = 1; + while(arguments.length > i)args.push(arguments[i++]); + queue[++counter] = function(){ + invoke(typeof fn == 'function' ? fn : Function(fn), args); + }; + defer(counter); + return counter; + }; + clearTask = function clearImmediate(id){ + delete queue[id]; + }; + // Node.js 0.8- + if(require('./_cof')(process) == 'process'){ + defer = function(id){ + process.nextTick(ctx(run, id, 1)); + }; + // Browsers with MessageChannel, includes WebWorkers + } else if(MessageChannel){ + channel = new MessageChannel; + port = channel.port2; + channel.port1.onmessage = listener; + defer = ctx(port.postMessage, port, 1); + // Browsers with postMessage, skip WebWorkers + // IE8 has postMessage, but it's sync & typeof its postMessage is 'object' + } else if(global.addEventListener && typeof postMessage == 'function' && !global.importScripts){ + defer = function(id){ + global.postMessage(id + '', '*'); + }; + global.addEventListener('message', listener, false); + // IE8- + } else if(ONREADYSTATECHANGE in cel('script')){ + defer = function(id){ + html.appendChild(cel('script'))[ONREADYSTATECHANGE] = function(){ + html.removeChild(this); + run.call(id); + }; + }; + // Rest old browsers + } else { + defer = function(id){ + setTimeout(ctx(run, id, 1), 0); + }; + } +} +module.exports = { + set: setTask, + clear: clearTask +}; +},{"./_cof":39,"./_ctx":41,"./_dom-create":43,"./_global":46,"./_html":48,"./_invoke":50}],55:[function(require,module,exports){ +// 7.1.1 ToPrimitive(input [, PreferredType]) +var isObject = require('./_is-object'); +// instead of the ES6 spec version, we didn't implement @@toPrimitive case +// and the second argument - flag - preferred type is a string +module.exports = function(it, S){ + if(!isObject(it))return it; + var fn, val; + if(S && typeof (fn = it.toString) == 'function' && !isObject(val = fn.call(it)))return val; + if(typeof (fn = it.valueOf) == 'function' && !isObject(val = fn.call(it)))return val; + if(!S && typeof (fn = it.toString) == 'function' && !isObject(val = fn.call(it)))return val; + throw TypeError("Can't convert object to primitive value"); +}; +},{"./_is-object":51}],56:[function(require,module,exports){ +var $export = require('./_export') + , $task = require('./_task'); +$export($export.G + $export.B, { + setImmediate: $task.set, + clearImmediate: $task.clear +}); +},{"./_export":44,"./_task":54}],57:[function(require,module,exports){ +(function (global){ +'use strict'; +var Mutation = global.MutationObserver || global.WebKitMutationObserver; + +var scheduleDrain; + +{ + if (Mutation) { + var called = 0; + var observer = new Mutation(nextTick); + var element = global.document.createTextNode(''); + observer.observe(element, { + characterData: true + }); + scheduleDrain = function () { + element.data = (called = ++called % 2); + }; + } else if (!global.setImmediate && typeof global.MessageChannel !== 'undefined') { + var channel = new global.MessageChannel(); + channel.port1.onmessage = nextTick; + scheduleDrain = function () { + channel.port2.postMessage(0); + }; + } else if ('document' in global && 'onreadystatechange' in global.document.createElement('script')) { + scheduleDrain = function () { + + // Create a + + + + + + + + + + +
+ +
+ +
+
+
Package 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.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/InvalidCredentialException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/InvalidCredentialException.html new file mode 100644 index 000000000..89db62002 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/InvalidCredentialException.html @@ -0,0 +1,371 @@ + + + + + +InvalidCredentialException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/InvalidLocationException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/InvalidLocationException.html new file mode 100644 index 000000000..47a8d34a7 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/InvalidLocationException.html @@ -0,0 +1,371 @@ + + + + + +InvalidLocationException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/InvalidPropertyException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/InvalidPropertyException.html new file mode 100644 index 000000000..7e069e259 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/InvalidPropertyException.html @@ -0,0 +1,371 @@ + + + + + +InvalidPropertyException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/PropertyTypeException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/PropertyTypeException.html new file mode 100644 index 000000000..7a424714b --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/PropertyTypeException.html @@ -0,0 +1,371 @@ + + + + + +PropertyTypeException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/UnknownAdaptorException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/UnknownAdaptorException.html new file mode 100644 index 000000000..49091621e --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/UnknownAdaptorException.html @@ -0,0 +1,369 @@ + + + + + +UnknownAdaptorException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/UnknownPropertyException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/UnknownPropertyException.html new file mode 100644 index 000000000..b3a68ed3e --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/UnknownPropertyException.html @@ -0,0 +1,371 @@ + + + + + +UnknownPropertyException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/UnsupportedOperationException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/UnsupportedOperationException.html new file mode 100644 index 000000000..bbdae78df --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/UnsupportedOperationException.html @@ -0,0 +1,369 @@ + + + + + +UnsupportedOperationException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      UnsupportedOperationException​(java.lang.String adaptorName, + java.lang.String message) 
      UnsupportedOperationException​(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

      + + + +
        +
      • +

        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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/XenonException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/XenonException.html new file mode 100644 index 000000000..0180360b2 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/XenonException.html @@ -0,0 +1,421 @@ + + + + + +XenonException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon
+

Class XenonException

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

      Field Summary

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

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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 TypeMethodDescription
      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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/XenonPropertyDescription.Type.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/XenonPropertyDescription.Type.html new file mode 100644 index 000000000..5801da51b --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/XenonPropertyDescription.Type.html @@ -0,0 +1,512 @@ + + + + + +XenonPropertyDescription.Type (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon
+

Enum XenonPropertyDescription.Type

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

      Enum Constant Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Enum Constants 
      Enum ConstantDescription
      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.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      private Type() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      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.
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Type

        +
        private Type()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/XenonPropertyDescription.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/XenonPropertyDescription.html new file mode 100644 index 000000000..0adfd9b91 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/XenonPropertyDescription.html @@ -0,0 +1,530 @@ + + + + + +XenonPropertyDescription (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeClassDescription
      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 TypeMethodDescription
      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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/XenonRuntimeException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/XenonRuntimeException.html new file mode 100644 index 000000000..bdfbe05d4 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/XenonRuntimeException.html @@ -0,0 +1,422 @@ + + + + + +XenonRuntimeException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private java.lang.StringadaptorName 
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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 TypeMethodDescription
      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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/Adaptor.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/Adaptor.html new file mode 100644 index 000000000..ecaf9f1a5 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/Adaptor.html @@ -0,0 +1,522 @@ + + + + + +Adaptor (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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.
        +
        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/AdaptorLoader.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/AdaptorLoader.html new file mode 100644 index 000000000..acb896534 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/AdaptorLoader.html @@ -0,0 +1,550 @@ + + + + + +AdaptorLoader (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors
+

Class AdaptorLoader

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

      Field Detail

      + + + +
        +
      • +

        LOGGER

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

        COMPONENT_NAME

        +
        private static final java.lang.String COMPONENT_NAME
        +
        The name of this component, for use in exceptions
        +
        +
        See Also:
        +
        Constant Field Values
        +
        +
        • +
      + + + +
        +
      • +

        fileAdaptors

        +
        private static final java.util.HashMap<java.lang.String,​FileAdaptor> fileAdaptors
        +
        • +
      + + + +
        +
      • +

        schedulerAdaptors

        +
        private static final java.util.HashMap<java.lang.String,​SchedulerAdaptor> schedulerAdaptors
        +
        • +
      + + + +
        +
      • +

        loaded

        +
        private static boolean loaded
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AdaptorLoader

        +
        public AdaptorLoader()
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/NotConnectedException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/NotConnectedException.html new file mode 100644 index 000000000..65256a270 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/NotConnectedException.html @@ -0,0 +1,371 @@ + + + + + +NotConnectedException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/XenonProperties.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/XenonProperties.html new file mode 100644 index 000000000..a778dc4d0 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/XenonProperties.html @@ -0,0 +1,1139 @@ + + + + + +XenonProperties (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      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 
      ModifierConstructorDescription
       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 TypeMethodDescription
      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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ConnectionLostException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ConnectionLostException.html new file mode 100644 index 000000000..7791b2298 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ConnectionLostException.html @@ -0,0 +1,371 @@ + + + + + +ConnectionLostException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/EndOfFileException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/EndOfFileException.html new file mode 100644 index 000000000..6569aa7d5 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/EndOfFileException.html @@ -0,0 +1,371 @@ + + + + + +EndOfFileException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/FileAdaptor.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/FileAdaptor.html new file mode 100644 index 000000000..3e1f2495d --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/FileAdaptor.html @@ -0,0 +1,583 @@ + + + + + +FileAdaptor (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.filesystems
+

Class FileAdaptor

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/NoSpaceException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/NoSpaceException.html new file mode 100644 index 000000000..e20f53d07 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/NoSpaceException.html @@ -0,0 +1,371 @@ + + + + + +NoSpaceException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/PathAttributesImplementation.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/PathAttributesImplementation.html new file mode 100644 index 000000000..186dd2f36 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/PathAttributesImplementation.html @@ -0,0 +1,1259 @@ + + + + + +PathAttributesImplementation (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      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 ?
      +
      +
      • +
    +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanequals​(java.lang.Object o) 
      longgetCreationTime() +
      Get the creation time for this file.
      +
      java.lang.StringgetGroup() +
      Get the group of this file.
      +
      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.
      +
      PathgetPath() +
      Get the path these attributes belong to.
      +
      java.util.Set<PosixFilePermission>getPermissions() +
      Get the permissions of this file.
      +
      longgetSize() +
      Get the size of this file in bytes.
      +
      inthashCode() 
      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 ?
      +
      voidsetCreationTime​(long creationTime) 
      voidsetDirectory​(boolean isDirectory) 
      voidsetExecutable​(boolean executable) 
      voidsetGroup​(java.lang.String group) 
      voidsetHidden​(boolean hidden) 
      voidsetLastAccessTime​(long lastAccessTime) 
      voidsetLastModifiedTime​(long lastModifiedTime) 
      voidsetOther​(boolean isOther) 
      voidsetOwner​(java.lang.String owner) 
      voidsetPath​(Path path) 
      voidsetPermissions​(java.util.Set<PosixFilePermission> permissions) 
      voidsetReadable​(boolean readable) 
      voidsetRegular​(boolean isRegular) 
      voidsetSize​(long size) 
      voidsetSymbolicLink​(boolean isSymbolicLink) 
      voidsetWritable​(boolean writable) 
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/PermissionDeniedException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/PermissionDeniedException.html new file mode 100644 index 000000000..fa0242d49 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/PermissionDeniedException.html @@ -0,0 +1,371 @@ + + + + + +PermissionDeniedException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/PosixFileUtils.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/PosixFileUtils.html new file mode 100644 index 000000000..4859bd140 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/PosixFileUtils.html @@ -0,0 +1,582 @@ + + + + + +PosixFileUtils (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static intEXEC_GROUP +
      execute/search by group
      +
      static intEXEC_OTHERS +
      execute/search by others
      +
      static intEXEC_OWNER +
      execute/search by owner
      +
      static intREAD_GROUP +
      read by group
      +
      static intREAD_OTHERS +
      read by others
      +
      static intREAD_OWNER +
      read by owner
      +
      static intWRITE_GROUP +
      write by group
      +
      static intWRITE_OTHERS +
      write by others
      +
      static intWRITE_OWNER +
      write by owner
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      PosixFileUtils() 
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PosixFileUtils

        +
        public 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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/RecursiveListIterator.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/RecursiveListIterator.html new file mode 100644 index 000000000..e3e14836f --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/RecursiveListIterator.html @@ -0,0 +1,410 @@ + + + + + +RecursiveListIterator (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      (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 TypeMethodDescription
      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>
        +
        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/TransferClientInputStream.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/TransferClientInputStream.html new file mode 100644 index 000000000..7f1feb314 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/TransferClientInputStream.html @@ -0,0 +1,574 @@ + + + + + +TransferClientInputStream (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.filesystems
+

Class TransferClientInputStream

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.io.InputStream
      • +
    • +
        +
      • nl.esciencecenter.xenon.adaptors.filesystems.TransferClientInputStream
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Closeable, java.lang.AutoCloseable
    +
    +
    +
    public class TransferClientInputStream
+extends java.io.InputStream
    +
    Wraps an InputStream instance. Only functionality added is calling an extra close on a transfer client after closing the input stream.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private java.io.Closeableclient 
      private java.io.InputStreaminputStream 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      TransferClientInputStream​(java.io.InputStream inputStream, + java.io.Closeable client) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      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.io.InputStream

        +nullInputStream, readAllBytes, readNBytes, readNBytes, transferTo
        • +
      +
        +
      • + + +

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

        client

        +
        private final java.io.Closeable client
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TransferClientInputStream

        +
        public TransferClientInputStream​(java.io.InputStream inputStream,
+                                 java.io.Closeable client)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      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.lang.AutoCloseable
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/TransferClientOutputStream.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/TransferClientOutputStream.html new file mode 100644 index 000000000..0bc0ed53d --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/TransferClientOutputStream.html @@ -0,0 +1,498 @@ + + + + + +TransferClientOutputStream (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.filesystems
+

Class TransferClientOutputStream

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • java.io.OutputStream
      • +
    • +
        +
      • nl.esciencecenter.xenon.adaptors.filesystems.TransferClientOutputStream
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable
    +
    +
    +
    public class TransferClientOutputStream
+extends java.io.OutputStream
    +
    Wraps an OutputStream instance. Only functionality added is calling an extra close on a transfer client after closing the output stream.
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private java.io.Closeableclient 
      private java.io.OutputStreamoutputStream 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      TransferClientOutputStream​(java.io.OutputStream outputStream, + java.io.Closeable client) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

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

        Methods inherited from class java.io.OutputStream

        +nullOutputStream
        • +
      +
        +
      • + + +

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

        client

        +
        private final java.io.Closeable client
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TransferClientOutputStream

        +
        public TransferClientOutputStream​(java.io.OutputStream outputStream,
+                                  java.io.Closeable client)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      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.lang.AutoCloseable
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpFileAdaptor.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpFileAdaptor.html new file mode 100644 index 000000000..93d67d90f --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpFileAdaptor.html @@ -0,0 +1,726 @@ + + + + + +FtpFileAdaptor (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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()
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpFileSystem.CloseableClient.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpFileSystem.CloseableClient.html new file mode 100644 index 000000000..fdf72b437 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpFileSystem.CloseableClient.html @@ -0,0 +1,378 @@ + + + + + +FtpFileSystem.CloseableClient (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.filesystems.ftp
+

Class FtpFileSystem.CloseableClient

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.filesystems.ftp.FtpFileSystem.CloseableClient
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Closeable, java.lang.AutoCloseable
    +
    +
    +
    Enclosing class:
    +
    FtpFileSystem
    +
    +
    +
    private static class FtpFileSystem.CloseableClient
+extends java.lang.Object
+implements java.io.Closeable
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private org.apache.commons.net.ftp.FTPClientclient 
      private booleanclosed 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      CloseableClient​(org.apache.commons.net.ftp.FTPClient client) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidclose() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        client

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

        closed

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

      Constructor Detail

      + + + +
        +
      • +

        CloseableClient

        +
        CloseableClient​(org.apache.commons.net.ftp.FTPClient client)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
+           throws java.io.IOException
        +
        +
        Specified by:
        +
        close in interface java.lang.AutoCloseable
        +
        Specified by:
        +
        close in interface java.io.Closeable
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpFileSystem.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpFileSystem.html new file mode 100644 index 000000000..4699a8d7a --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/FtpFileSystem.html @@ -0,0 +1,1161 @@ + + + + + +FtpFileSystem (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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
        +
        +
        • +
      + + + +
        +
      • +

        checkClientReply

        +
        private void checkClientReply​(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.
        +
        +
        • +
      + + + + + + + + + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/package-summary.html new file mode 100644 index 000000000..3ccffc3bf --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/package-summary.html @@ -0,0 +1,172 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.ftp (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

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

+
+
+ +
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/package-tree.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/package-tree.html new file mode 100644 index 000000000..64a7598d4 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/ftp/package-tree.html @@ -0,0 +1,175 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.ftp Class Hierarchy (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

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

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/LocalFileAdaptor.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/LocalFileAdaptor.html new file mode 100644 index 000000000..3c8c8d7c4 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/LocalFileAdaptor.html @@ -0,0 +1,622 @@ + + + + + +LocalFileAdaptor (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.filesystems.local
+

Class LocalFileAdaptor

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/LocalFileSystem.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/LocalFileSystem.html new file mode 100644 index 000000000..fc4c12fd8 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/LocalFileSystem.html @@ -0,0 +1,1012 @@ + + + + + +LocalFileSystem (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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.
        +
        +
        • +
      + + + + + + + + + + + + + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/package-summary.html new file mode 100644 index 000000000..ab7306f17 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/local/package-summary.html @@ -0,0 +1,170 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.local (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

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

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

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

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/package-summary.html new file mode 100644 index 000000000..858e2bf6e --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/package-summary.html @@ -0,0 +1,227 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Package nl.esciencecenter.xenon.adaptors.filesystems

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

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

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/SftpFileAdaptor.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/SftpFileAdaptor.html new file mode 100644 index 000000000..e6cef0d10 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/SftpFileAdaptor.html @@ -0,0 +1,840 @@ + + + + + +SftpFileAdaptor (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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()
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/SftpFileSystem.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/SftpFileSystem.html new file mode 100644 index 000000000..221fd355f --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/SftpFileSystem.html @@ -0,0 +1,1035 @@ + + + + + +SftpFileSystem (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/package-summary.html new file mode 100644 index 000000000..cb8fd47bb --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/package-summary.html @@ -0,0 +1,168 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.sftp (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

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

+
+
+ +
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/package-tree.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/package-tree.html new file mode 100644 index 000000000..33ebc1c25 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/sftp/package-tree.html @@ -0,0 +1,174 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.sftp Class Hierarchy (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

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

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/WebdavFileAdaptor.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/WebdavFileAdaptor.html new file mode 100644 index 000000000..67b5f9078 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/WebdavFileAdaptor.html @@ -0,0 +1,623 @@ + + + + + +WebdavFileAdaptor (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.filesystems.webdav
+

Class WebdavFileAdaptor

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/WebdavFileSystem.StreamToFileWriter.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/WebdavFileSystem.StreamToFileWriter.html new file mode 100644 index 000000000..1f02778cb --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/WebdavFileSystem.StreamToFileWriter.html @@ -0,0 +1,412 @@ + + + + + +WebdavFileSystem.StreamToFileWriter (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private java.io.InputStreamin 
      private java.lang.Stringurl 
      +
        +
      • + + +

        Fields inherited from class java.lang.Thread

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

      Constructor Summary

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

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidrun() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Thread

        +activeCount, checkAccess, clone, countStackFrames, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, 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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/WebdavFileSystem.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/WebdavFileSystem.html new file mode 100644 index 000000000..d651be391 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/WebdavFileSystem.html @@ -0,0 +1,1010 @@ + + + + + +WebdavFileSystem (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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.
        +
        +
        • +
      + + + + + + + + + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/package-summary.html new file mode 100644 index 000000000..cb5bf39f6 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/package-summary.html @@ -0,0 +1,168 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.webdav (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

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

+
+
+ +
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/package-tree.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/package-tree.html new file mode 100644 index 000000000..38cbd06bf --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/filesystems/webdav/package-tree.html @@ -0,0 +1,179 @@ + + + + + +nl.esciencecenter.xenon.adaptors.filesystems.webdav Class Hierarchy (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

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

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/package-summary.html new file mode 100644 index 000000000..1604cd6d1 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/package-summary.html @@ -0,0 +1,191 @@ + + + + + +nl.esciencecenter.xenon.adaptors (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Package nl.esciencecenter.xenon.adaptors

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

Hierarchy For Package nl.esciencecenter.xenon.adaptors

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/BadParameterException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/BadParameterException.html new file mode 100644 index 000000000..da4fed7d8 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/BadParameterException.html @@ -0,0 +1,371 @@ + + + + + +BadParameterException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/BatchProcess.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/BatchProcess.html new file mode 100644 index 000000000..48ca7cbc3 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/BatchProcess.html @@ -0,0 +1,545 @@ + + + + + +BatchProcess (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        substituteJobID

        +
        private java.lang.String substituteJobID​(java.lang.String path,
+                                         java.lang.String jobIdentifier)
        +
        • +
      + + + +
        +
      • +

        processPath

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

        closeStreams

        +
        private void closeStreams()
        +
        • +
      + + + +
        +
      • +

        isDone

        +
        public boolean isDone()
        +
        +
        Specified by:
        +
        isDone in interface Process
        +
        +
        • +
      + + + +
        +
      • +

        getExitStatus

        +
        public int getExitStatus()
        +
        +
        Specified by:
        +
        getExitStatus in interface Process
        +
        +
        • +
      + + + +
        +
      • +

        destroy

        +
        public void destroy()
        +
        +
        Specified by:
        +
        destroy in interface Process
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/Deadline.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/Deadline.html new file mode 100644 index 000000000..3b43fa655 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/Deadline.html @@ -0,0 +1,323 @@ + + + + + +Deadline (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 
      ConstructorDescription
      Deadline() +
      No need to use this constructor, use static methods instead.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      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.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/IncompatibleVersionException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/IncompatibleVersionException.html new file mode 100644 index 000000000..736ead135 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/IncompatibleVersionException.html @@ -0,0 +1,371 @@ + + + + + +IncompatibleVersionException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/InteractiveProcess.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/InteractiveProcess.html new file mode 100644 index 000000000..a7a51f96a --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/InteractiveProcess.html @@ -0,0 +1,264 @@ + + + + + +InteractiveProcess (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.schedulers
+

Interface InteractiveProcess

+
+
+
+ +
+
+ +
+
+
    +
  • + +
    + +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/InteractiveProcessFactory.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/InteractiveProcessFactory.html new file mode 100644 index 000000000..352ef14d3 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/InteractiveProcessFactory.html @@ -0,0 +1,301 @@ + + + + + +InteractiveProcessFactory (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.schedulers
+

Interface InteractiveProcessFactory

+
+
+
+ +
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobCanceledException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobCanceledException.html new file mode 100644 index 000000000..1e209fa84 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobCanceledException.html @@ -0,0 +1,371 @@ + + + + + +JobCanceledException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobExecutor.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobExecutor.html new file mode 100644 index 000000000..08472bea8 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobExecutor.html @@ -0,0 +1,1038 @@ + + + + + +JobExecutor (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobQueueScheduler.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobQueueScheduler.html new file mode 100644 index 000000000..3566d96b0 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobQueueScheduler.html @@ -0,0 +1,1296 @@ + + + + + +JobQueueScheduler (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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.
        +
        +
        • +
      + + + +
        +
      • +

        getDefaultRuntime

        +
        public int getDefaultRuntime()
        +
        Description copied from class: Scheduler
        +
        Get the default runtime of a job in minutes. + + If no default runtime is available, -1 will be returned. If the default runtime is infinite, 0 will be returned.
        +
        +
        Specified by:
        +
        getDefaultRuntime in class Scheduler
        +
        Returns:
        +
        the default runtime of a job in minutes, -1 if no default is available, 0 if the default is infinite.
        +
        +
        • +
      + + + +
        +
      • +

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

        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.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobSeenMap.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobSeenMap.html new file mode 100644 index 000000000..cdbfd4926 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobSeenMap.html @@ -0,0 +1,462 @@ + + + + + +JobSeenMap (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.schedulers
+

Class JobSeenMap

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

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private java.util.Set<java.lang.String>deletedJobs 
      private longexpireTime 
      private java.util.Map<java.lang.String,​java.lang.Long>lastSeenMap +
      Map with the last seen time of jobs.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      JobSeenMap() 
      JobSeenMap​(long expireTime) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidaddDeletedJob​(java.lang.String jobIdentifier) 
      longgetExpireTime() 
      booleanhaveRecentlySeen​(java.lang.String identifier) 
      booleanjobWasDeleted​(java.lang.String jobIdentifier) 
      voidupdateRecentlySeen​(java.lang.String... identifiers) 
      voidupdateRecentlySeen​(java.util.Set<java.lang.String> identifiers) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        expireTime

        +
        private final long expireTime
        +
        • +
      + + + +
        +
      • +

        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.String> deletedJobs
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        JobSeenMap

        +
        public JobSeenMap()
        +
        • +
      + + + +
        +
      • +

        JobSeenMap

        +
        public JobSeenMap​(long expireTime)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getExpireTime

        +
        public long getExpireTime()
        +
        • +
      + + + +
        +
      • +

        updateRecentlySeen

        +
        public void updateRecentlySeen​(java.lang.String... identifiers)
        +
        • +
      + + + +
        +
      • +

        updateRecentlySeen

        +
        public void updateRecentlySeen​(java.util.Set<java.lang.String> identifiers)
        +
        • +
      + + + +
        +
      • +

        haveRecentlySeen

        +
        public boolean haveRecentlySeen​(java.lang.String identifier)
        +
        • +
      + + + +
        +
      • +

        addDeletedJob

        +
        public void addDeletedJob​(java.lang.String jobIdentifier)
        +
        • +
      + + + +
        +
      • +

        jobWasDeleted

        +
        public boolean jobWasDeleted​(java.lang.String jobIdentifier)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobStatusImplementation.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobStatusImplementation.html new file mode 100644 index 000000000..f0d97a940 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/JobStatusImplementation.html @@ -0,0 +1,756 @@ + + + + + +JobStatusImplementation (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 
      ConstructorDescription
      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 TypeMethodDescription
      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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/Process.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/Process.html new file mode 100644 index 000000000..0edb10deb --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/Process.html @@ -0,0 +1,284 @@ + + + + + +Process (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.schedulers
+

Interface Process

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

      Method Detail

      + + + +
        +
      • +

        isDone

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

        getExitStatus

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

        destroy

        +
        void destroy()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/QueueStatusImplementation.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/QueueStatusImplementation.html new file mode 100644 index 000000000..0c3ac481f --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/QueueStatusImplementation.html @@ -0,0 +1,555 @@ + + + + + +QueueStatusImplementation (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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.
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      QueueStatusImplementation​(Scheduler scheduler, + java.lang.String queueName, + XenonException exception, + java.util.Map<java.lang.String,​java.lang.String> schedulerSpecificInformation) +
      Create a Queue status.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      XenonExceptiongetException() +
      Get the exception produced by the queue, or null if hasException() returns false.
      +
      java.lang.StringgetQueueName() +
      Get the queue name.
      +
      SchedulergetScheduler() +
      Get the Scheduler that produced this QueueStatus.
      +
      java.util.Map<java.lang.String,​java.lang.String>getSchedulerSpecificInformation() +
      Get scheduler specific information on the queue.
      +
      booleanhasException() +
      Did the queue produce an exception ?
      +
      voidmaybeThrowException() +
      Throws the exception produced by the queue if it exists.
      +
      java.lang.StringtoString() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/RemoteCommandRunner.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/RemoteCommandRunner.html new file mode 100644 index 000000000..1e4209161 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/RemoteCommandRunner.html @@ -0,0 +1,482 @@ + + + + + +RemoteCommandRunner (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private java.lang.Stringerror 
      private intexitCode 
      private static org.slf4j.LoggerLOGGER 
      private java.lang.Stringoutput 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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.
      +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

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

        successIgnoreError

        +
        public boolean successIgnoreError()
        +
        • +
      + + + +
        +
      • +

        toString

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

Class SchedulerAdaptor

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

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static java.lang.StringADAPTORS_PREFIX 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

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

      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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/SchedulerClosedException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/SchedulerClosedException.html new file mode 100644 index 000000000..9ee4c50ae --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/SchedulerClosedException.html @@ -0,0 +1,371 @@ + + + + + +SchedulerClosedException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingParser.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingParser.html new file mode 100644 index 000000000..a4c3092bb --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingParser.html @@ -0,0 +1,689 @@ + + + + + +ScriptingParser (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 
      ConstructorDescription
      ScriptingParser() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      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

        +
        public 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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingScheduler.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingScheduler.html new file mode 100644 index 000000000..ff1758667 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingScheduler.html @@ -0,0 +1,815 @@ + + + + + +ScriptingScheduler (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.schedulers
+

Class ScriptingScheduler

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

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

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

        getDefaultRuntime

        +
        public int getDefaultRuntime()
        +
        Description copied from class: Scheduler
        +
        Get the default runtime of a job in minutes. + + If no default runtime is available, -1 will be returned. If the default runtime is infinite, 0 will be returned.
        +
        +
        Specified by:
        +
        getDefaultRuntime in class Scheduler
        +
        Returns:
        +
        the default runtime of a job in minutes, -1 if no default is available, 0 if the default is infinite.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingSchedulerAdaptor.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingSchedulerAdaptor.html new file mode 100644 index 000000000..d99516ccd --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingSchedulerAdaptor.html @@ -0,0 +1,407 @@ + + + + + +ScriptingSchedulerAdaptor (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingUtils.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingUtils.html new file mode 100644 index 000000000..848de19d6 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ScriptingUtils.html @@ -0,0 +1,584 @@ + + + + + +ScriptingUtils (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 
      ConstructorDescription
      ScriptingUtils() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      static java.lang.StringasCSList​(java.lang.String[] values) +
      Create a single comma separated string out of a list of strings.
      +
      static voidcheckQueue​(java.lang.String[] queueNames, + java.lang.String queueName, + java.lang.String adaptorName) +
      Check if the given queueName is presents in queueNames.
      +
      static java.lang.Stringconcat​(java.lang.String... strings) +
      Concatinate a series of Strings using a StringBuilder.
      +
      static XenonPropertiesgetProperties​(XenonPropertyDescription[] validProperties, + java.lang.String location, + java.util.Map<java.lang.String,​java.lang.String> properties) 
      static java.lang.StringgetWorkingDirPath​(JobDescription description, + Path currentWorkingDir) +
      Retrieve a working directory from a JobDescription and, if necessary, resolve it against a current working directory.
      +
      static booleanisLocal​(java.lang.String location) 
      static booleanisSSH​(java.lang.String location) 
      static XenonPropertyDescription[]mergeValidProperties​(XenonPropertyDescription[]... prop) 
      static java.lang.StringprotectAgainstShellMetas​(java.lang.String argument) +
      Escapes and quotes command line arguments to keep shells from expanding/interpreting them.
      +
      static voidverifyJobDescription​(JobDescription description, + java.lang.String[] queueNames, + 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 voidverifyStartTime​(java.lang.String startTime, + java.lang.String adaptorName) +
      Verify a String containing a start time.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        ScriptingUtils

        +
        public ScriptingUtils()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isLocal

        +
        public static boolean isLocal​(java.lang.String location)
        +
        • +
      + + + +
        +
      • +

        isSSH

        +
        public static boolean isSSH​(java.lang.String location)
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        verifyStartTime

        +
        public static void verifyStartTime​(java.lang.String startTime,
+                                   java.lang.String adaptorName)
+                            throws XenonException
        +
        Verify a String containing a start time. + + Currently supported values are "now", or an explicit time and date in the format "HH:mm[ dd.MM[.YYYY]]"
        +
        +
        Parameters:
        +
        startTime - the start time to parse
        +
        adaptorName - the name of the calling adaptor (used in exceptions).
        +
        Throws:
        +
        XenonException - if the startTime does not have an accepted format
        +
        +
        • +
      + + + +
        +
      • +

        getWorkingDirPath

        +
        public static java.lang.String getWorkingDirPath​(JobDescription description,
+                                                 Path currentWorkingDir)
        +
        Retrieve a working directory from a JobDescription and, if necessary, resolve it against a current working directory. + + This method retrieves the working directory from a JobDescription. If it is not specified, the currentWorkingDir will be + returned. If it is specified and an absolute path, it will be returned directly. Otherwise, it will first be resolved against the provided + currentWorkingDir and the resulting path will be returned.
        +
        +
        Parameters:
        +
        description - the JobDescription containing the workingDirectory
        +
        currentWorkingDir - the current working directory of the adaptor. Must not be null.
        +
        Returns:
        +
        the retrieved (and possibly resolved) working directory.
        +
        +
        • +
      + + + +
        +
      • +

        checkQueue

        +
        public static void checkQueue​(java.lang.String[] queueNames,
+                              java.lang.String queueName,
+                              java.lang.String adaptorName)
+                       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 names of the available queues.
        +
        queueName - the queueName to check.
        +
        adaptorName - the name of the calling adaptor (used in exceptions).
        +
        Throws:
        +
        NoSuchQueueException - if workingDirectory does not exist, or an error occurred.
        +
        +
        • +
      + + + +
        +
      • +

        verifyJobDescription

        +
        public static void verifyJobDescription​(JobDescription description,
+                                        java.lang.String[] queueNames,
+                                        java.lang.String adaptorName)
+                                 throws XenonException
        +
        Do some checks on a job description.
        +
        +
        Parameters:
        +
        description - the job description to check
        +
        queueNames - the names of the available queues.
        +
        adaptorName - the name of the adaptor. Used when an exception is thrown
        +
        Throws:
        +
        IncompleteJobDescriptionException - if the description is missing a mandatory value.
        +
        InvalidJobDescriptionException - if the description contains illegal values.
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

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

        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.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/StreamsImplementation.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/StreamsImplementation.html new file mode 100644 index 000000000..6fcbc910c --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/StreamsImplementation.html @@ -0,0 +1,526 @@ + + + + + +StreamsImplementation (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private java.lang.StringjobIdentifier 
      private java.io.InputStreamstderr 
      private java.io.OutputStreamstdin 
      private java.io.InputStreamstdout 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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 TypeMethodDescription
      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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/at/AtScheduler.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/at/AtScheduler.html new file mode 100644 index 000000000..3ae086efa --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/at/AtScheduler.html @@ -0,0 +1,847 @@ + + + + + +AtScheduler (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.schedulers.at
+

Class AtScheduler

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.AutoCloseable
    +
    +
    +
    public class AtScheduler
+extends ScriptingScheduler
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        LOGGER

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

        QNAMES

        +
        private static final java.lang.String[] QNAMES
        +
        • +
      + + + +
        +
      • +

        DEFAULT_QUEUE

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

        jobSeenMap

        +
        private final JobSeenMap jobSeenMap
        +
        • +
      + + + +
        +
      • +

        nextUniqueID

        +
        private long nextUniqueID
        +
        • +
      +
      • +
    +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        checkQueue

        +
        private void checkQueue​(java.lang.String queueName)
+                 throws XenonException
        +
        Checks if the provided queue name is valid, and throws an exception otherwise. + + Checks against a predefined list of queue names that at uses: a-z, A-Z, and =.
        +
        +
        Parameters:
        +
        queueName - the queue name to check for validity
        +
        Throws:
        +
        NoSuchQueueException - if the queue name is not valid
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        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.
        +
        +
        Overrides:
        +
        checkQueueNames in class ScriptingScheduler
        +
        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
        +
        NoSuchQueueException - if one or more of the queue names is not known in the scheduler
        +
        XenonException
        +
        +
        • +
      + + + + + + + +
        +
      • +

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

        getJobInfo

        +
        private java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.String>> getJobInfo​(java.lang.String[] queueNames)
+                                                                                                         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.
        +
        +
        • +
      + + + +
        +
      • +

        getUniqueID

        +
        private java.lang.String getUniqueID()
        +
        • +
      + + + + + + + + + + + +
        +
      • +

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

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

        getDefaultRuntime

        +
        public int getDefaultRuntime()
        +
        Description copied from class: Scheduler
        +
        Get the default runtime of a job in minutes. + + If no default runtime is available, -1 will be returned. If the default runtime is infinite, 0 will be returned.
        +
        +
        Overrides:
        +
        getDefaultRuntime in class ScriptingScheduler
        +
        Returns:
        +
        the default runtime of a job in minutes, -1 if no default is available, 0 if the default is infinite.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/at/AtSchedulerAdaptor.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/at/AtSchedulerAdaptor.html new file mode 100644 index 000000000..d3173cbeb --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/at/AtSchedulerAdaptor.html @@ -0,0 +1,520 @@ + + + + + +AtSchedulerAdaptor (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.schedulers.at
+

Class AtSchedulerAdaptor

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

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

        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
        +
        • +
      +
      • +
    +
    + +
    + +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/at/AtUtils.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/at/AtUtils.html new file mode 100644 index 000000000..08f8122fe --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/at/AtUtils.html @@ -0,0 +1,514 @@ + + + + + +AtUtils (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.schedulers.at
+

Class AtUtils

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

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private static org.slf4j.LoggerLOGGER 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      AtUtils() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      private static voidecho​(java.util.Formatter script, + java.lang.String label, + java.lang.String message, + java.lang.String file) 
      static java.lang.StringgenerateJobScript​(JobDescription description, + Path fsEntryPath, + java.lang.String tmpID) 
      static java.lang.String[]getJobIDs​(java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.String>> jobs) 
      private static java.lang.StringgetStream​(java.lang.String target) 
      static java.util.HashMap<java.lang.String,​java.util.Map<java.lang.String,​java.lang.String>>parseJobInfo​(java.lang.String atqOutput, + java.util.Set<java.lang.String> queues) +
      Parse one or more lines of queue info as produced by atq.
      +
      static voidparseJobLine​(java.lang.String line, + java.util.Set<java.lang.String> queues, + java.util.HashMap<java.lang.String,​java.util.Map<java.lang.String,​java.lang.String>> result) 
      static java.lang.StringparseSubmitOutput​(java.lang.String output) 
      protected static java.lang.StringsubstituteJobID​(java.lang.String path, + java.lang.String jobID) 
      static voidverifyJobDescription​(JobDescription description, + java.lang.String[] queueNames) 
      +
        +
      • + + +

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

      Constructor Detail

      + + + +
        +
      • +

        AtUtils

        +
        public AtUtils()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        parseJobLine

        +
        public static void parseJobLine​(java.lang.String line,
+                                java.util.Set<java.lang.String> queues,
+                                java.util.HashMap<java.lang.String,​java.util.Map<java.lang.String,​java.lang.String>> result)
        +
        • +
      + + + +
        +
      • +

        parseJobInfo

        +
        public static java.util.HashMap<java.lang.String,​java.util.Map<java.lang.String,​java.lang.String>> parseJobInfo​(java.lang.String atqOutput,
+                                                                                                                            java.util.Set<java.lang.String> queues)
        +
        Parse one or more lines of queue info as produced by atq. + + These lines have the following syntax: + + [jobID] [weekday] [month] [dayOfMonth] [time] [year] [queue] [user] + + For example: + + 11 Mon Jul 2 10:22:00 2018 a jason + + The parsed output will be split into "jobID", "startDate", "queue" and "user" data, which is combined in a Map (each using the respective keys). Each of + this Maps is stored is a larger Map using the "jobID" as a key. This larger map is returned as the return value this method. + + For example, the example line above will result in the following return value: + Map("11":Map("jobID":"11", "startDate":"Mon Jul 2 10:22:00 2018", "queue":"a", "user":"jason")) + If a set of queue names is provided in queues, only jobs from a matching queue will be returned in results. If queues + is null or empty, all jobs from all queues will be returned.
        +
        +
        Parameters:
        +
        atqOutput - the output as produced by atq
        +
        queues - the queues to return the jobs for.
        +
        Returns:
        +
        the parsed output
        +
        +
        • +
      + + + +
        +
      • +

        parseSubmitOutput

        +
        public static java.lang.String parseSubmitOutput​(java.lang.String output)
+                                          throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        getJobIDs

        +
        public static java.lang.String[] getJobIDs​(java.util.Map<java.lang.String,​java.util.Map<java.lang.String,​java.lang.String>> jobs)
        +
        • +
      + + + + + + + +
        +
      • +

        getStream

        +
        private static java.lang.String getStream​(java.lang.String target)
        +
        • +
      + + + +
        +
      • +

        echo

        +
        private static void echo​(java.util.Formatter script,
+                         java.lang.String label,
+                         java.lang.String message,
+                         java.lang.String file)
        +
        • +
      + + + +
        +
      • +

        substituteJobID

        +
        protected static java.lang.String substituteJobID​(java.lang.String path,
+                                                  java.lang.String jobID)
        +
        • +
      + + + +
        +
      • +

        generateJobScript

        +
        public static java.lang.String generateJobScript​(JobDescription description,
+                                                 Path fsEntryPath,
+                                                 java.lang.String tmpID)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/at/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/at/package-summary.html new file mode 100644 index 000000000..f5569cad3 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/at/package-summary.html @@ -0,0 +1,172 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.at (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Package nl.esciencecenter.xenon.adaptors.schedulers.at

+
+
+ +
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/at/package-tree.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/at/package-tree.html new file mode 100644 index 000000000..a763db2ea --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/at/package-tree.html @@ -0,0 +1,183 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.at Class Hierarchy (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.schedulers.at

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineScheduler.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineScheduler.html new file mode 100644 index 000000000..0d41df5c6 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineScheduler.html @@ -0,0 +1,834 @@ + + + + + +GridEngineScheduler (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

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

        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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineSchedulerAdaptor.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineSchedulerAdaptor.html new file mode 100644 index 000000000..1abf54cc4 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineSchedulerAdaptor.html @@ -0,0 +1,562 @@ + + + + + +GridEngineSchedulerAdaptor (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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
        +
        • +
      +
      • +
    +
    + +
    + +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineSetup.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineSetup.html new file mode 100644 index 000000000..6778f6c9f --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineSetup.html @@ -0,0 +1,588 @@ + + + + + +GridEngineSetup (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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
        +
        • +
      + + + +
        +
      • +

        defaultRuntime

        +
        private final int defaultRuntime
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + + + + + +
        +
      • +

        GridEngineSetup

        +
        GridEngineSetup​(java.lang.String[] queueNames,
+                java.util.Map<java.lang.String,​QueueInfo> queues,
+                java.util.Map<java.lang.String,​ParallelEnvironmentInfo> parallelEnvironments,
+                int defaultRuntime)
        +
        Testing constructor.
        +
        +
        Parameters:
        +
        queueNames - queue names to use.
        +
        queues - queues to use.
        +
        parallelEnvironments - parallel environments to use.
        +
        defaultRuntime - the default runtime 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()
        +
        • +
      + + + +
        +
      • +

        getDefaultRuntime

        +
        public int getDefaultRuntime()
        +
        • +
      + + + +
        +
      • +

        getSingleNodeParallelEnvironment

        +
        java.util.Optional<ParallelEnvironmentInfo> getSingleNodeParallelEnvironment​(int coresPerNode,
+                                                                             java.lang.String queueName)
        +
        Try to find a parallel environment that can be used to get a number of cores on a single node
        +
        +
        Parameters:
        +
        coresPerNode - number of cores to reserve on a node
        +
        queueName - Name of the queue
        +
        Returns:
        +
        optional parallel environment
        +
        +
        • +
      + + + +
        +
      • +

        getMultiNodeParallelEnvironment

        +
        java.util.Optional<ParallelEnvironmentInfo> getMultiNodeParallelEnvironment​(int coresPerNode,
+                                                                            int nodes,
+                                                                            java.lang.String queueName)
        +
        Try to find a parallel environment that can be used to get X number of cores per node on Y number of nodes
        +
        +
        Parameters:
        +
        coresPerNode - number of cores to reserve on each node
        +
        nodes - number of nodes to reserve
        +
        queueName - Name of the queue
        +
        Returns:
        +
        optional parallel environment
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineUtils.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineUtils.html new file mode 100644 index 000000000..7a939e324 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineUtils.html @@ -0,0 +1,526 @@ + + + + + +GridEngineUtils (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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
        +
        • +
      + + + +
        +
      • +

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

        substituteJobID

        +
        protected static java.lang.String substituteJobID​(java.lang.String path)
        +
        • +
      + + + + + + + +
        +
      • +

        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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineXmlParser.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineXmlParser.html new file mode 100644 index 000000000..efc092579 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/GridEngineXmlParser.html @@ -0,0 +1,509 @@ + + + + + +GridEngineXmlParser (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 
      ConstructorDescription
      GridEngineXmlParser​(boolean ignoreVersion) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/ParallelEnvironmentInfo.AllocationRule.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/ParallelEnvironmentInfo.AllocationRule.html new file mode 100644 index 000000000..c84a6efc8 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/ParallelEnvironmentInfo.AllocationRule.html @@ -0,0 +1,448 @@ + + + + + +ParallelEnvironmentInfo.AllocationRule (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.schedulers.gridengine
+

Enum ParallelEnvironmentInfo.AllocationRule

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

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      private AllocationRule() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      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
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AllocationRule

        +
        private AllocationRule()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/ParallelEnvironmentInfo.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/ParallelEnvironmentInfo.html new file mode 100644 index 000000000..7cca8e4ff --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/ParallelEnvironmentInfo.html @@ -0,0 +1,599 @@ + + + + + +ParallelEnvironmentInfo (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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
        +
        +
        • +
      + + + +
        +
      • +

        canAllocateSingleNode

        +
        boolean canAllocateSingleNode​(int coresPerNode)
        +
        Check if pe can allocate all slots on the same node
        +
        +
        Parameters:
        +
        coresPerNode - number of cores to reserve on a node
        +
        Returns:
        +
        True if pe can
        +
        +
        • +
      + + + +
        +
      • +

        canAllocateMultiNode

        +
        boolean canAllocateMultiNode​(int coresPerNode,
+                             int nodes)
        +
        Check if pe can allocate X number of cores per node on Y number of nodes
        +
        +
        Parameters:
        +
        coresPerNode - number of cores to reserve on each node
        +
        nodes - number of nodes to reserve
        +
        Returns:
        +
        True if pe can
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/QueueInfo.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/QueueInfo.html new file mode 100644 index 000000000..a467d2e07 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/QueueInfo.html @@ -0,0 +1,452 @@ + + + + + +QueueInfo (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private java.lang.Stringname 
      private java.lang.String[]parallelEnvironments 
      private intslots 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      QueueInfo​(java.lang.String name, + int slots, + java.lang.String... parallelEnvironments) +
      Testing constructor
      +
      QueueInfo​(java.util.Map<java.lang.String,​java.lang.String> info) 
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      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.util.Map<java.lang.String,​java.lang.String> info)
+   throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/package-summary.html new file mode 100644 index 000000000..8b3bb8c47 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/package-summary.html @@ -0,0 +1,215 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.gridengine (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Package nl.esciencecenter.xenon.adaptors.schedulers.gridengine

+
+
+ +
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/package-tree.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/package-tree.html new file mode 100644 index 000000000..db274e656 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/gridengine/package-tree.html @@ -0,0 +1,201 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.gridengine Class Hierarchy (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.schedulers.gridengine

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Enum Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/CommandNotFoundException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/CommandNotFoundException.html new file mode 100644 index 000000000..4febeab88 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/CommandNotFoundException.html @@ -0,0 +1,371 @@ + + + + + +CommandNotFoundException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/CommandRunner.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/CommandRunner.html new file mode 100644 index 000000000..9a591c3d2 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/CommandRunner.html @@ -0,0 +1,458 @@ + + + + + +CommandRunner (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 
      ConstructorDescription
      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 TypeMethodDescription
      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()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/LocalInteractiveProcess.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/LocalInteractiveProcess.html new file mode 100644 index 000000000..483db73c3 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/LocalInteractiveProcess.html @@ -0,0 +1,530 @@ + + + + + +LocalInteractiveProcess (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.schedulers.local
+

Class LocalInteractiveProcess

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcess
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      LocalInteractiveProcess​(JobDescription description, + java.lang.String workdir, + java.lang.String jobIdentifier) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voiddestroy() +
      Destroy (stop) process.
      +
      voiddestroy​(int timeout, + java.util.concurrent.TimeUnit unit) +
      Destroy (stop) process.
      +
      private booleandestroyProcess​(java.lang.ProcessHandle s, + int timeout, + java.util.concurrent.TimeUnit unit) 
      intgetExitStatus() 
      StreamsgetStreams() 
      booleanisDone() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

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

        destroyProcess

        +
        private boolean destroyProcess​(java.lang.ProcessHandle s,
+                               int timeout,
+                               java.util.concurrent.TimeUnit unit)
        +
        • +
      + + + +
        +
      • +

        destroy

        +
        public void destroy​(int timeout,
+                    java.util.concurrent.TimeUnit unit)
        +
        Destroy (stop) process. Does nothing if the process has already finished. Will try a destroy first, followed by a destroyForcibly if the process has not + terminated after the given timeout. All subprocessed that can be found will also be destroyed.
        +
        +
        Parameters:
        +
        timeout - the timeout for each destroy and destroyForcibly operation.
        +
        unit - the unit of the timeout.
        +
        +
        • +
      + + + +
        +
      • +

        destroy

        +
        public void destroy()
        +
        Destroy (stop) process. Does nothing if the process has already finished. Will try a destroy first, followed by a destroyForcibly if the process has not + terminated after 1 second. All subprocessed that can be found will also be destroyed.
        +
        +
        Specified by:
        +
        destroy in interface Process
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/LocalInteractiveProcessFactory.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/LocalInteractiveProcessFactory.html new file mode 100644 index 000000000..848920ab2 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/LocalInteractiveProcessFactory.html @@ -0,0 +1,406 @@ + + + + + +LocalInteractiveProcessFactory (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.schedulers.local
+

Class LocalInteractiveProcessFactory

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.local.LocalInteractiveProcessFactory
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private booleanopen 
      +
      • +
    +
    + +
    + +
    + +
    + +
    +
    • +
+
+
+ +
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/LocalSchedulerAdaptor.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/LocalSchedulerAdaptor.html new file mode 100644 index 000000000..16f96a11f --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/LocalSchedulerAdaptor.html @@ -0,0 +1,743 @@ + + + + + +LocalSchedulerAdaptor (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.schedulers.local
+

Class LocalSchedulerAdaptor

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

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      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.
        +
        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/package-summary.html new file mode 100644 index 000000000..c20191e5f --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/package-summary.html @@ -0,0 +1,199 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.local (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Package nl.esciencecenter.xenon.adaptors.schedulers.local

+
+
+ +
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/package-tree.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/package-tree.html new file mode 100644 index 000000000..3381349e7 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/local/package-tree.html @@ -0,0 +1,185 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.local Class Hierarchy (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

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

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/package-summary.html new file mode 100644 index 000000000..9504bf112 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/package-summary.html @@ -0,0 +1,286 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Package nl.esciencecenter.xenon.adaptors.schedulers

+
+
+ +
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/package-tree.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/package-tree.html new file mode 100644 index 000000000..9d0f46272 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/package-tree.html @@ -0,0 +1,212 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers Class Hierarchy (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

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

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmScheduler.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmScheduler.html new file mode 100644 index 000000000..03409b31e --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmScheduler.html @@ -0,0 +1,852 @@ + + + + + +SlurmScheduler (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmSchedulerAdaptor.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmSchedulerAdaptor.html new file mode 100644 index 000000000..06c64267f --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmSchedulerAdaptor.html @@ -0,0 +1,622 @@ + + + + + +SlurmSchedulerAdaptor (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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
        +
        • +
      +
      • +
    +
    + +
    + +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmSetup.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmSetup.html new file mode 100644 index 000000000..a4e377d68 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmSetup.html @@ -0,0 +1,413 @@ + + + + + +SlurmSetup (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private booleanaccountingAvailable 
      private static org.slf4j.LoggerLOGGER 
      private java.lang.Stringversion 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmUtils.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmUtils.html new file mode 100644 index 000000000..41f685901 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/SlurmUtils.html @@ -0,0 +1,710 @@ + + + + + +SlurmUtils (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      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.
      +
      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).
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      private SlurmUtils() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      protected static java.lang.IntegerexitcodeFromString​(java.lang.String value) 
      static java.lang.Stringgenerate​(JobDescription description, + Path fsEntryPath, + int defaultRuntime) 
      static java.lang.String[]generateInteractiveArguments​(JobDescription description, + Path fsEntryPath, + java.util.UUID tag, + int defaultRuntime) 
      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) 
      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, + java.lang.String[] queueNames, + 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
        +
        • +
      + + + +
        +
      • +

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

        verifyJobDescription

        +
        protected static void verifyJobDescription​(JobDescription description,
+                                           java.lang.String[] queueNames,
+                                           boolean interactive)
+                                    throws XenonException
        +
        +
        Throws:
        +
        XenonException
        +
        +
        • +
      + + + +
        +
      • +

        generateInteractiveArguments

        +
        public static java.lang.String[] generateInteractiveArguments​(JobDescription description,
+                                                              Path fsEntryPath,
+                                                              java.util.UUID tag,
+                                                              int defaultRuntime)
        +
        • +
      + + + +
        +
      • +

        generate

        +
        public static java.lang.String generate​(JobDescription description,
+                                        Path fsEntryPath,
+                                        int defaultRuntime)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/package-summary.html new file mode 100644 index 000000000..7b68d2975 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/package-summary.html @@ -0,0 +1,180 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.slurm (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Package nl.esciencecenter.xenon.adaptors.schedulers.slurm

+
+
+ +
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/package-tree.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/package-tree.html new file mode 100644 index 000000000..00cb45bd2 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/slurm/package-tree.html @@ -0,0 +1,184 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.slurm Class Hierarchy (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.schedulers.slurm

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/SshInteractiveProcess.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/SshInteractiveProcess.html new file mode 100644 index 000000000..e99b02fba --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/SshInteractiveProcess.html @@ -0,0 +1,505 @@ + + + + + +SshInteractiveProcess (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.schedulers.ssh
+

Class SshInteractiveProcess

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcess
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      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 
      ConstructorDescription
      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
        +
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/SshInteractiveProcessFactory.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/SshInteractiveProcessFactory.html new file mode 100644 index 000000000..1d1e286bf --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/SshInteractiveProcessFactory.html @@ -0,0 +1,408 @@ + + + + + +SshInteractiveProcessFactory (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.schedulers.ssh
+

Class SshInteractiveProcessFactory

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.adaptors.schedulers.ssh.SshInteractiveProcessFactory
      • +
    +
    • +
+
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/SshSchedulerAdaptor.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/SshSchedulerAdaptor.html new file mode 100644 index 000000000..f3c4cede8 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/SshSchedulerAdaptor.html @@ -0,0 +1,960 @@ + + + + + +SshSchedulerAdaptor (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.adaptors.schedulers.ssh
+

Class SshSchedulerAdaptor

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

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      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.
        +
        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/package-summary.html new file mode 100644 index 000000000..cd1d16a1f --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/package-summary.html @@ -0,0 +1,174 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.ssh (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Package nl.esciencecenter.xenon.adaptors.schedulers.ssh

+
+
+ +
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/package-tree.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/package-tree.html new file mode 100644 index 000000000..9e0ce2085 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/ssh/package-tree.html @@ -0,0 +1,171 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.ssh Class Hierarchy (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.schedulers.ssh

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueScheduler.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueScheduler.html new file mode 100644 index 000000000..95667c435 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueScheduler.html @@ -0,0 +1,851 @@ + + + + + +TorqueScheduler (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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
        +
        • +
      + + + + + + + +
        +
      • +

        jobsSeenMap

        +
        private final JobSeenMap jobsSeenMap
        +
        • +
      + + + +
        +
      • +

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

        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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueSchedulerAdaptor.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueSchedulerAdaptor.html new file mode 100644 index 000000000..00ad600ae --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueSchedulerAdaptor.html @@ -0,0 +1,567 @@ + + + + + +TorqueSchedulerAdaptor (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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
        +
        • +
      +
      • +
    +
    + +
    + +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueUtils.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueUtils.html new file mode 100644 index 000000000..658455f0c --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueUtils.html @@ -0,0 +1,457 @@ + + + + + +TorqueUtils (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private static org.slf4j.LoggerLOGGER 
      private static intMINUTES_PER_HOUR 
      static java.util.regex.PatternQUEUE_INFO_NAME 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      private TorqueUtils() 
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

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

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

        substituteJobID

        +
        public static java.lang.String substituteJobID​(java.lang.String path)
        +
        • +
      + + + +
        +
      • +

        generate

        +
        public static java.lang.String generate​(JobDescription description,
+                                        Path workdir,
+                                        int defaultRuntime)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueXmlParser.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueXmlParser.html new file mode 100644 index 000000000..49117678a --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/TorqueXmlParser.html @@ -0,0 +1,427 @@ + + + + + +TorqueXmlParser (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private javax.xml.parsers.DocumentBuilderdocumentBuilder 
      private static org.slf4j.LoggerLOGGER 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      TorqueXmlParser() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/package-summary.html new file mode 100644 index 000000000..ae0f5f04c --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/package-summary.html @@ -0,0 +1,184 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.torque (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

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.
    +
    +
    • +
+
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/package-tree.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/package-tree.html new file mode 100644 index 000000000..c969c3fca --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/schedulers/torque/package-tree.html @@ -0,0 +1,184 @@ + + + + + +nl.esciencecenter.xenon.adaptors.schedulers.torque Class Hierarchy (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package nl.esciencecenter.xenon.adaptors.schedulers.torque

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/CertificateNotFoundException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/CertificateNotFoundException.html new file mode 100644 index 000000000..7c0c64671 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/CertificateNotFoundException.html @@ -0,0 +1,369 @@ + + + + + +CertificateNotFoundException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/CredentialNotFoundException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/CredentialNotFoundException.html new file mode 100644 index 000000000..23ad1c00c --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/CredentialNotFoundException.html @@ -0,0 +1,369 @@ + + + + + +CredentialNotFoundException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHConnection.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHConnection.html new file mode 100644 index 000000000..1631f54f7 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHConnection.html @@ -0,0 +1,522 @@ + + + + + +SSHConnection (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private org.apache.sshd.client.SshClientclient 
      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 
      ModifierConstructorDescription
      protected SSHConnection​(org.apache.sshd.client.SshClient client, + int hops) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      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

      + + + +
        +
      • +

        client

        +
        private final org.apache.sshd.client.SshClient client
        +
        • +
      + + + +
        +
      • +

        sessions

        +
        private final 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​(org.apache.sshd.client.SshClient client,
+                        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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHUtil.PasswordProvider.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHUtil.PasswordProvider.html new file mode 100644 index 000000000..4bb0a73fa --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHUtil.PasswordProvider.html @@ -0,0 +1,397 @@ + + + + + +SSHUtil.PasswordProvider (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Nested Class Summary

      +
        +
      • + + +

        Nested classes/interfaces inherited from interface org.apache.sshd.common.config.keys.FilePasswordProvider

        +org.apache.sshd.common.config.keys.FilePasswordProvider.ResourceDecodeResult
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private char[]password 
      +
        +
      • + + +

        Fields inherited from interface org.apache.sshd.common.config.keys.FilePasswordProvider

        +EMPTY
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      PasswordProvider​(char[] password) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      java.lang.StringgetPassword​(org.apache.sshd.common.session.SessionContext session, + org.apache.sshd.common.NamedResource resourceKey, + int retryIndex) 
      +
        +
      • + + +

        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

        +handleDecodeAttemptResult
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        password

        +
        private final char[] password
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PasswordProvider

        +
        public PasswordProvider​(char[] password)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getPassword

        +
        public java.lang.String getPassword​(org.apache.sshd.common.session.SessionContext session,
+                                    org.apache.sshd.common.NamedResource resourceKey,
+                                    int retryIndex)
+                             throws java.io.IOException
        +
        +
        Specified by:
        +
        getPassword in interface org.apache.sshd.common.config.keys.FilePasswordProvider
        +
        Throws:
        +
        java.io.IOException
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHUtil.Tunnel.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHUtil.Tunnel.html new file mode 100644 index 000000000..25a522f32 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHUtil.Tunnel.html @@ -0,0 +1,498 @@ + + + + + +SSHUtil.Tunnel (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      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 
      ConstructorDescription
      Tunnel​(java.net.ServerSocket ss, + org.apache.sshd.client.channel.ChannelDirectTcpip tmp, + int bufferSize) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      voidclose() 
      private voidcloseServer() 
      java.lang.ExceptiongetException() 
      voidrun() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Thread

        +activeCount, checkAccess, clone, countStackFrames, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, 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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHUtil.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHUtil.html new file mode 100644 index 000000000..cb70897b1 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/SSHUtil.html @@ -0,0 +1,732 @@ + + + + + +SSHUtil (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeClassDescription
      (package private) static class SSHUtil.PasswordProvider 
      (package private) static class SSHUtil.Tunnel 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      static intDEFAULT_SSH_PORT 
      private static org.slf4j.LoggerLOGGER 
      private static java.lang.StringVIA_TAG 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      SSHUtil() +
      This constructor is only needed for testing.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/package-summary.html new file mode 100644 index 000000000..46876d06e --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/package-summary.html @@ -0,0 +1,199 @@ + + + + + +nl.esciencecenter.xenon.adaptors.shared.ssh (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Package nl.esciencecenter.xenon.adaptors.shared.ssh

+
+
+ +
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/package-tree.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/package-tree.html new file mode 100644 index 000000000..199c2f057 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/adaptors/shared/ssh/package-tree.html @@ -0,0 +1,182 @@ + + + + + +nl.esciencecenter.xenon.adaptors.shared.ssh Class Hierarchy (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

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) + +
      • +
    +
    • +
+
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/CertificateCredential.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/CertificateCredential.html new file mode 100644 index 000000000..9b68c300f --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/CertificateCredential.html @@ -0,0 +1,440 @@ + + + + + +CertificateCredential (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.credentials
+

Class CertificateCredential

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

      Field Summary

      + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private java.lang.Stringcertfile +
      This member variables holds the URI of the file containing the certificate.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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.
        +
        +
        • +
      + + + + + + + + + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/Credential.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/Credential.html new file mode 100644 index 000000000..e2b483d11 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/Credential.html @@ -0,0 +1,197 @@ + + + + + +Credential (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.credentials
+

Interface Credential

+
+
+
+ +
+
+
+ +
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/CredentialMap.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/CredentialMap.html new file mode 100644 index 000000000..c0294bd33 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/CredentialMap.html @@ -0,0 +1,532 @@ + + + + + +CredentialMap (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 
      ConstructorDescription
      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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/DefaultCredential.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/DefaultCredential.html new file mode 100644 index 000000000..d933758e1 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/DefaultCredential.html @@ -0,0 +1,413 @@ + + + + + +DefaultCredential (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private java.lang.Stringusername 
      +
      • +
    +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/KeytabCredential.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/KeytabCredential.html new file mode 100644 index 000000000..85c7e4d92 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/KeytabCredential.html @@ -0,0 +1,427 @@ + + + + + +KeytabCredential (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.credentials
+

Class KeytabCredential

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.credentials.KeytabCredential
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private java.lang.StringkeytabFile 
      private java.lang.Stringusername 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      KeytabCredential​(java.lang.String username, + java.lang.String keytabFile) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      booleanequals​(java.lang.Object obj) 
      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 obj)
        +
        +
        Overrides:
        +
        equals in class java.lang.Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class java.lang.Object
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/PasswordCredential.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/PasswordCredential.html new file mode 100644 index 000000000..5197e5c03 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/PasswordCredential.html @@ -0,0 +1,496 @@ + + + + + +PasswordCredential (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.credentials
+

Class PasswordCredential

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.credentials.PasswordCredential
      • +
    +
    • +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      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 
      ConstructorDescription
      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 TypeMethodDescription
      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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/UserCredential.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/UserCredential.html new file mode 100644 index 000000000..956379916 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/UserCredential.html @@ -0,0 +1,264 @@ + + + + + +UserCredential (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/package-summary.html new file mode 100644 index 000000000..24c2ac541 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/package-summary.html @@ -0,0 +1,214 @@ + + + + + +nl.esciencecenter.xenon.credentials (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Package nl.esciencecenter.xenon.credentials

+
+
+
+ + +
This package contains classes and interfaces for managing credentials.
+
+
    +
  • + + + + + + + + + + + + + + + + +
    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.
    +
    +
    • +
+
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/package-tree.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/package-tree.html new file mode 100644 index 000000000..7eb8f70da --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/credentials/package-tree.html @@ -0,0 +1,178 @@ + + + + + +nl.esciencecenter.xenon.credentials Class Hierarchy (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package nl.esciencecenter.xenon.credentials

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/AttributeNotSupportedException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/AttributeNotSupportedException.html new file mode 100644 index 000000000..05c5a2030 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/AttributeNotSupportedException.html @@ -0,0 +1,371 @@ + + + + + +AttributeNotSupportedException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/CopyCancelledException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/CopyCancelledException.html new file mode 100644 index 000000000..9da60c6db --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/CopyCancelledException.html @@ -0,0 +1,305 @@ + + + + + +CopyCancelledException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/CopyMode.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/CopyMode.html new file mode 100644 index 000000000..305efdd52 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/CopyMode.html @@ -0,0 +1,447 @@ + + + + + +CopyMode (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 ConstantDescription
      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.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      private CopyMode() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      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.
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        CopyMode

        +
        private CopyMode()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/CopyStatus.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/CopyStatus.html new file mode 100644 index 000000000..714d8d9de --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/CopyStatus.html @@ -0,0 +1,435 @@ + + + + + +CopyStatus (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeMethodDescription
      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.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/DirectoryNotEmptyException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/DirectoryNotEmptyException.html new file mode 100644 index 000000000..531600139 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/DirectoryNotEmptyException.html @@ -0,0 +1,371 @@ + + + + + +DirectoryNotEmptyException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.CopyCallback.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.CopyCallback.html new file mode 100644 index 000000000..f0715b048 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.CopyCallback.html @@ -0,0 +1,448 @@ + + + + + +FileSystem.CopyCallback (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      (package private) longbytesCopied 
      (package private) longbytesToCopy 
      (package private) booleancancelled 
      (package private) booleanstarted 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      CopyCallback() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      (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()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.CopyStatusImplementation.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.CopyStatusImplementation.html new file mode 100644 index 000000000..0f01a47f5 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.CopyStatusImplementation.html @@ -0,0 +1,683 @@ + + + + + +FileSystem.CopyStatusImplementation (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 
      ConstructorDescription
      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 TypeMethodDescription
      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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.PendingCopy.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.PendingCopy.html new file mode 100644 index 000000000..ec2f1f46a --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.PendingCopy.html @@ -0,0 +1,328 @@ + + + + + +FileSystem.PendingCopy (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      (package private) FileSystem.CopyCallbackcallback 
      (package private) java.util.concurrent.Future<java.lang.Void>future 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.html new file mode 100644 index 000000000..b87a5bc38 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystem.html @@ -0,0 +1,2278 @@ + + + + + +FileSystem (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.filesystems
+

Class FileSystem

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.filesystems.FileSystem
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.AutoCloseable
    +
    +
    +
    Direct Known Subclasses:
    +
    FtpFileSystem, LocalFileSystem, SftpFileSystem, WebdavFileSystem
    +
    +
    +
    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.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        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

      + + + + + + + +
        +
      • +

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

        getBufferSize

        +
        protected int getBufferSize()
        +
        • +
      + + + +
        +
      • +

        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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystemAdaptorDescription.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystemAdaptorDescription.html new file mode 100644 index 000000000..81a640e62 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystemAdaptorDescription.html @@ -0,0 +1,405 @@ + + + + + +FileSystemAdaptorDescription (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystemClosedException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystemClosedException.html new file mode 100644 index 000000000..0b08b6e81 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/FileSystemClosedException.html @@ -0,0 +1,371 @@ + + + + + +FileSystemClosedException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/InvalidOptionsException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/InvalidOptionsException.html new file mode 100644 index 000000000..57e6bff5c --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/InvalidOptionsException.html @@ -0,0 +1,371 @@ + + + + + +InvalidOptionsException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/InvalidPathException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/InvalidPathException.html new file mode 100644 index 000000000..bfa1a7c4b --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/InvalidPathException.html @@ -0,0 +1,371 @@ + + + + + +InvalidPathException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/InvalidResumeTargetException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/InvalidResumeTargetException.html new file mode 100644 index 000000000..ee4340db0 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/InvalidResumeTargetException.html @@ -0,0 +1,371 @@ + + + + + +InvalidResumeTargetException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/NoSuchCopyException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/NoSuchCopyException.html new file mode 100644 index 000000000..2ca2126d4 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/NoSuchCopyException.html @@ -0,0 +1,371 @@ + + + + + +NoSuchCopyException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/NoSuchPathException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/NoSuchPathException.html new file mode 100644 index 000000000..d5a3494b3 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/NoSuchPathException.html @@ -0,0 +1,371 @@ + + + + + +NoSuchPathException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/Path.PathIterator.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/Path.PathIterator.html new file mode 100644 index 000000000..9a72dc2a0 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/Path.PathIterator.html @@ -0,0 +1,404 @@ + + + + + +Path.PathIterator (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private intindex 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      private PathIterator() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      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>
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/Path.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/Path.html new file mode 100644 index 000000000..bc426c52e --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/Path.html @@ -0,0 +1,1226 @@ + + + + + +Path (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeClassDescription
      private class Path.PathIterator 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      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 
      ConstructorDescription
      Path() +
      Create a new empty Path using the default separator.
      +
      Path​(boolean isAbsolute, + java.lang.String... elements) +
      Create a new Path using the given path elements and 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​(char separator, + boolean isAbsolute, + java.lang.String... elements) +
      Create a new Path using the given path elements and the provided 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, + 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 TypeMethodDescription
      protected static java.util.List<java.lang.String>checkForNullAndSeparator​(char separator, + java.util.List<java.lang.String> elements) 
      booleanendsWith​(java.lang.String other) +
      Tests if this Path ends with the given Path represented as a String.
      +
      booleanendsWith​(Path other) +
      Tests if this Path ends with the given Path.
      +
      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​(java.lang.String other) +
      Resolve a Path represented as a String against this path.
      +
      Pathresolve​(Path other) +
      Resolve a Path against this Path.
      +
      PathresolveSibling​(Path other) +
      Resolves the given Path to this paths parent Path, thereby creating a sibling to this Path.
      +
      booleanstartsWith​(java.lang.String other) +
      Tests if this Path starts with the given Path represented as a String.
      +
      booleanstartsWith​(Path other) +
      Tests if this Path starts with the given Path.
      +
      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()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/PathAlreadyExistsException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/PathAlreadyExistsException.html new file mode 100644 index 000000000..d48f2a75a --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/PathAlreadyExistsException.html @@ -0,0 +1,371 @@ + + + + + +PathAlreadyExistsException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/PathAttributes.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/PathAttributes.html new file mode 100644 index 000000000..d05dbf888 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/PathAttributes.html @@ -0,0 +1,592 @@ + + + + + +PathAttributes (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeMethodDescription
      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.
        +
        +
        • +
      + + + + + + + + + + + + +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/PosixFilePermission.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/PosixFilePermission.html new file mode 100644 index 000000000..fdbea8736 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/PosixFilePermission.html @@ -0,0 +1,751 @@ + + + + + +PosixFilePermission (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        OTHERS_EXECUTE_BIT

        +
        private static int OTHERS_EXECUTE_BIT
        +
        • +
      + + + +
        +
      • +

        OTHERS_WRITE_BIT

        +
        private static int OTHERS_WRITE_BIT
        +
        • +
      + + + +
        +
      • +

        OTHERS_READ_BIT

        +
        private static int OTHERS_READ_BIT
        +
        • +
      + + + +
        +
      • +

        GROUP_EXECUTE_BIT

        +
        private static int GROUP_EXECUTE_BIT
        +
        • +
      + + + +
        +
      • +

        GROUP_WRITE_BIT

        +
        private static int GROUP_WRITE_BIT
        +
        • +
      + + + +
        +
      • +

        GROUP_READ_BIT

        +
        private static int GROUP_READ_BIT
        +
        • +
      + + + +
        +
      • +

        OWNER_EXECUTE_BIT

        +
        private static int OWNER_EXECUTE_BIT
        +
        • +
      + + + +
        +
      • +

        OWNER_WRITE_BIT

        +
        private static int OWNER_WRITE_BIT
        +
        • +
      + + + +
        +
      • +

        OWNER_READ_BIT

        +
        private static int OWNER_READ_BIT
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PosixFilePermission

        +
        private PosixFilePermission()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

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

        convertToOctal

        +
        public static java.lang.String convertToOctal​(java.util.Set<PosixFilePermission> permissions)
        +
        • +
      + + + +
        +
      • +

        convertFromOctal

        +
        public static java.util.Set<PosixFilePermission> convertFromOctal​(java.lang.String octal)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/package-summary.html new file mode 100644 index 000000000..83093d5a6 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/package-summary.html @@ -0,0 +1,302 @@ + + + + + +nl.esciencecenter.xenon.filesystems (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Package nl.esciencecenter.xenon.filesystems

+
+
+
+ + +
This package contains classes and interfaces for manipulating files.
+
+ +
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/package-tree.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/package-tree.html new file mode 100644 index 000000000..5e8f04331 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/filesystems/package-tree.html @@ -0,0 +1,215 @@ + + + + + +nl.esciencecenter.xenon.filesystems Class Hierarchy (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

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) + +
      • +
    +
    • +
+
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/package-summary.html new file mode 100644 index 000000000..2e65f43ea --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/package-summary.html @@ -0,0 +1,271 @@ + + + + + +nl.esciencecenter.xenon (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Package nl.esciencecenter.xenon

+
+
+
+ + +
This package is the main entry point into the Xenon API.
+
+
    +
  • + + + + + + + + + + + + +
    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.
    +
    +
    • +
+
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/package-tree.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/package-tree.html new file mode 100644 index 000000000..3051e0947 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/package-tree.html @@ -0,0 +1,205 @@ + + + + + +nl.esciencecenter.xenon Class Hierarchy (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package nl.esciencecenter.xenon

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Enum Hierarchy

+
    +
  • java.lang.Object + +
    • +
+
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/IncompleteJobDescriptionException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/IncompleteJobDescriptionException.html new file mode 100644 index 000000000..ee20401eb --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/IncompleteJobDescriptionException.html @@ -0,0 +1,371 @@ + + + + + +IncompleteJobDescriptionException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/InvalidJobDescriptionException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/InvalidJobDescriptionException.html new file mode 100644 index 000000000..72a64170f --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/InvalidJobDescriptionException.html @@ -0,0 +1,371 @@ + + + + + +InvalidJobDescriptionException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/JobDescription.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/JobDescription.html new file mode 100644 index 000000000..db630192e --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/JobDescription.html @@ -0,0 +1,1615 @@ + + + + + +JobDescription (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private java.util.List<java.lang.String>arguments +
      The arguments to pass to the executable.
      +
      private intcoresPerTask +
      The number of cores needed per tasks.
      +
      static java.lang.StringDEFAULT_START_TIME +
      The default start 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 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 java.lang.StringqueueName +
      The queue to submit to.
      +
      private java.util.List<java.lang.String>schedulerArguments +
      The arguments to pass to the scheduler.
      +
      private booleanstartPerTask +
      Start the executable once per task instead of once per job?
      +
      private java.lang.StringstartTime +
      The requested start time
      +
      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 inttasks +
      The number of tasks the jobs consists of.
      +
      private inttasksPerNode +
      The number of tasks per node
      +
      private inttempSpace +
      The tempspace needed (in MB) on each node/process.
      +
      private java.lang.StringworkingDirectory +
      The working directory for the job.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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 TypeMethodDescription
      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.
      +
      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.
      +
      intgetCoresPerTask() +
      Get the number of cores needed for each task.
      +
      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.
      +
      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.
      +
      java.lang.StringgetQueueName() +
      Get the queue name;
      +
      java.util.List<java.lang.String>getSchedulerArguments() +
      Get the scheduler specific arguments.
      +
      java.lang.StringgetStartTime() +
      Get the start time of the job.
      +
      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.
      +
      intgetTasks() +
      Get the number of tasks in this job.
      +
      intgetTasksPerNode() +
      Get the number of tasks per node.
      +
      intgetTempSpace() +
      Get the amount of temp space needed for process (in MBytes).
      +
      java.lang.StringgetWorkingDirectory() +
      Gets the path of the working directory for the executable.
      +
      inthashCode() 
      booleanisStartPerJob() +
      Will the executable be started per job? + + true by default.
      +
      booleanisStartPerTask() +
      Will the executable be started per task? + + false by default.
      +
      voidsetArguments​(java.lang.String... arguments) +
      Sets the command line arguments of the executable.
      +
      voidsetCoresPerTask​(int coresPerTask) +
      Set the number of cores needed for each task.
      +
      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.
      +
      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.
      +
      voidsetQueueName​(java.lang.String queueName) +
      Set the queue name;
      +
      voidsetSchedulerArguments​(java.lang.String... arguments) +
      Sets the scheduler specific arguments for this job.
      +
      voidsetStartPerJob() +
      Set if the executable must be started for once per job instead of for each task.
      +
      voidsetStartPerTask() +
      Set if the executable must be started for each task instead of once per job.
      +
      voidsetStartTime​(java.lang.String startTime) +
      Set the start time of the job.
      +
      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.
      +
      voidsetTasks​(int tasks) +
      Set the number of tasks in this job.
      +
      voidsetTasksPerNode​(int tasksPerNode) +
      Set the number of tasks allowed per node.
      +
      voidsetTempSpace​(int tempSpaceInMB) +
      Set the amount of memory needed for process (in MBytes).
      +
      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_START_TIME

        +
        public static final java.lang.String DEFAULT_START_TIME
        +
        The default start 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
        +
        • +
      + + + +
        +
      • +

        tasks

        +
        private int tasks
        +
        The number of tasks the jobs consists of.
        +
        • +
      + + + +
        +
      • +

        coresPerTask

        +
        private int coresPerTask
        +
        The number of cores needed per tasks.
        +
        • +
      + + + +
        +
      • +

        tasksPerNode

        +
        private int tasksPerNode
        +
        The number of tasks per node
        +
        • +
      + + + +
        +
      • +

        maxMemory

        +
        private int maxMemory
        +
        The maximum amount of memory needed (in MB) on each node/process.
        +
        • +
      + + + +
        +
      • +

        tempSpace

        +
        private int tempSpace
        +
        The tempspace needed (in MB) on each node/process.
        +
        • +
      + + + +
        +
      • +

        startPerTask

        +
        private boolean startPerTask
        +
        Start the executable once per task instead of once per job?
        +
        • +
      + + + +
        +
      • +

        maxRuntime

        +
        private int maxRuntime
        +
        The maximum run time in minutes.
        +
        • +
      + + + +
        +
      • +

        startTime

        +
        private java.lang.String startTime
        +
        The requested start time
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

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

        getTasks

        +
        public int getTasks()
        +
        Get the number of tasks in this job.
        +
        +
        Returns:
        +
        the number of tasks.
        +
        +
        • +
      + + + +
        +
      • +

        setTasks

        +
        public void setTasks​(int tasks)
        +
        Set the number of tasks in this job.
        +
        +
        Parameters:
        +
        tasks - the number of tasks;
        +
        +
        • +
      + + + +
        +
      • +

        getCoresPerTask

        +
        public int getCoresPerTask()
        +
        Get the number of cores needed for each task.
        +
        +
        Returns:
        +
        the number of cores needed for each task.
        +
        +
        • +
      + + + +
        +
      • +

        setCoresPerTask

        +
        public void setCoresPerTask​(int coresPerTask)
        +
        Set the number of cores needed for each task.
        +
        +
        Parameters:
        +
        coresPerTask - the number of cores needed for each task.
        +
        +
        • +
      + + + +
        +
      • +

        getTasksPerNode

        +
        public int getTasksPerNode()
        +
        Get the number of tasks per node.
        +
        +
        Returns:
        +
        the number of tasks per node.
        +
        +
        • +
      + + + +
        +
      • +

        setTasksPerNode

        +
        public void setTasksPerNode​(int tasksPerNode)
        +
        Set the number of tasks allowed per node.
        +
        +
        Parameters:
        +
        tasksPerNode - the number of tasks allowed per node.
        +
        +
        • +
      + + + +
        +
      • +

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

        getTempSpace

        +
        public int getTempSpace()
        +
        Get the amount of temp space needed for process (in MBytes).
        +
        +
        Returns:
        +
        the amount of temp space needed.
        +
        +
        • +
      + + + +
        +
      • +

        setTempSpace

        +
        public void setTempSpace​(int tempSpaceInMB)
        +
        Set the amount of memory needed for process (in MBytes).
        +
        +
        Parameters:
        +
        tempSpaceInMB - the amount of temp space needed per node/process.
        +
        +
        • +
      + + + +
        +
      • +

        isStartPerTask

        +
        public boolean isStartPerTask()
        +
        Will the executable be started per task? + + false by default.
        +
        +
        Returns:
        +
        if the executable is started per task.
        +
        +
        • +
      + + + +
        +
      • +

        isStartPerJob

        +
        public boolean isStartPerJob()
        +
        Will the executable be started per job? + + true by default.
        +
        +
        Returns:
        +
        if the executable is started per job.
        +
        +
        • +
      + + + +
        +
      • +

        setStartPerTask

        +
        public void setStartPerTask()
        +
        Set if the executable must be started for each task instead of once per job.
        +
        • +
      + + + +
        +
      • +

        setStartPerJob

        +
        public void setStartPerJob()
        +
        Set if the executable must be started for once per job instead of for each task.
        +
        • +
      + + + +
        +
      • +

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

        getStartTime

        +
        public java.lang.String getStartTime()
        +
        Get the start time of the job.
        +
        +
        Returns:
        +
        the start time of the job.
        +
        +
        • +
      + + + +
        +
      • +

        setStartTime

        +
        public void setStartTime​(java.lang.String startTime)
        +
        Set the start time of the job. + + Currently supported values are "now", or an explicit time and optional date in the format "HH:mm[ dd.MM[.YYYY]]"
        +
        +
        Parameters:
        +
        startTime - the start time of the job.
        +
        +
        • +
      + + + +
        +
      • +

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

        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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/JobStatus.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/JobStatus.html new file mode 100644 index 000000000..288457016 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/JobStatus.html @@ -0,0 +1,458 @@ + + + + + +JobStatus (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeMethodDescription
      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.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/NoSuchJobException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/NoSuchJobException.html new file mode 100644 index 000000000..1a39130fc --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/NoSuchJobException.html @@ -0,0 +1,371 @@ + + + + + +NoSuchJobException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/NoSuchQueueException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/NoSuchQueueException.html new file mode 100644 index 000000000..b82a11f25 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/NoSuchQueueException.html @@ -0,0 +1,371 @@ + + + + + +NoSuchQueueException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static longserialVersionUID 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/QueueStatus.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/QueueStatus.html new file mode 100644 index 000000000..502bffca2 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/QueueStatus.html @@ -0,0 +1,369 @@ + + + + + +QueueStatus (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/Scheduler.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/Scheduler.html new file mode 100644 index 000000000..4020df825 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/Scheduler.html @@ -0,0 +1,1297 @@ + + + + + +Scheduler (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 
      ModifierConstructorDescription
      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 TypeMethodDescription
      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 intgetDefaultRuntime() +
      Get the default runtime of a job in minutes.
      +
      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

      + + + +
        +
      • +

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

        getDefaultRuntime

        +
        public abstract int getDefaultRuntime()
+                               throws XenonException
        +
        Get the default runtime of a job in minutes. + + If no default runtime is available, -1 will be returned. If the default runtime is infinite, 0 will be returned.
        +
        +
        Returns:
        +
        the default runtime of a job in minutes, -1 if no default is available, 0 if the default is infinite.
        +
        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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/SchedulerAdaptorDescription.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/SchedulerAdaptorDescription.html new file mode 100644 index 000000000..4f5ab67f3 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/SchedulerAdaptorDescription.html @@ -0,0 +1,357 @@ + + + + + +SchedulerAdaptorDescription (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.schedulers
+

Interface SchedulerAdaptorDescription

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

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethodDescription
      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 ?
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/Streams.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/Streams.html new file mode 100644 index 000000000..c9a0f6b55 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/Streams.html @@ -0,0 +1,329 @@ + + + + + +Streams (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeMethodDescription
      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.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/UnsupportedJobDescriptionException.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/UnsupportedJobDescriptionException.html new file mode 100644 index 000000000..818ca5064 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/UnsupportedJobDescriptionException.html @@ -0,0 +1,371 @@ + + + + + +UnsupportedJobDescriptionException (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      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)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/package-summary.html new file mode 100644 index 000000000..cae460412 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/package-summary.html @@ -0,0 +1,251 @@ + + + + + +nl.esciencecenter.xenon.schedulers (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Package nl.esciencecenter.xenon.schedulers

+
+
+
+ + +
This package contains the classes and interfaces used to run jobs.
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + +
    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.
    +
    +
    • +
+
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/package-tree.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/package-tree.html new file mode 100644 index 000000000..30f92d710 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/schedulers/package-tree.html @@ -0,0 +1,192 @@ + + + + + +nl.esciencecenter.xenon.schedulers Class Hierarchy (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package nl.esciencecenter.xenon.schedulers

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/DaemonThreadFactory.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/DaemonThreadFactory.html new file mode 100644 index 000000000..4ee72ac6e --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/DaemonThreadFactory.html @@ -0,0 +1,383 @@ + + + + + +DaemonThreadFactory (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package nl.esciencecenter.xenon.utils
+

Class DaemonThreadFactory

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • nl.esciencecenter.xenon.utils.DaemonThreadFactory
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.util.concurrent.ThreadFactory
    +
    +
    +
    public class DaemonThreadFactory
+extends java.lang.Object
+implements java.util.concurrent.ThreadFactory
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeFieldDescription
      private intcount 
      private java.lang.Stringname 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ConstructorDescription
      DaemonThreadFactory​(java.lang.String name) 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      private intgetCount() 
      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
        • +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        name

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

        count

        +
        private int count
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DaemonThreadFactory

        +
        public DaemonThreadFactory​(java.lang.String name)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCount

        +
        private int getCount()
        +
        • +
      + + + +
        +
      • +

        newThread

        +
        public java.lang.Thread newThread​(java.lang.Runnable runnable)
        +
        +
        Specified by:
        +
        newThread in interface java.util.concurrent.ThreadFactory
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/InputWriter.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/InputWriter.html new file mode 100644 index 000000000..0edbf5e25 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/InputWriter.html @@ -0,0 +1,501 @@ + + + + + +InputWriter (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      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 
      ConstructorDescription
      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 TypeMethodDescription
      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, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, 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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/JavaJobDescription.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/JavaJobDescription.html new file mode 100644 index 000000000..7bcefa56d --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/JavaJobDescription.html @@ -0,0 +1,846 @@ + + + + + +JavaJobDescription (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/LocalFileSystemUtils.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/LocalFileSystemUtils.html new file mode 100644 index 000000000..0ee66ec5b --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/LocalFileSystemUtils.html @@ -0,0 +1,732 @@ + + + + + +LocalFileSystemUtils (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      private static java.lang.StringADAPTOR_NAME 
      private static java.lang.StringOS_PROPERTY 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + +
      Constructors 
      ModifierConstructorDescription
      private LocalFileSystemUtils() 
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Concrete Methods 
      Modifier and TypeMethodDescription
      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.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/OutputReader.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/OutputReader.html new file mode 100644 index 000000000..d6fd18b99 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/OutputReader.html @@ -0,0 +1,566 @@ + + + + + +OutputReader (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      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 
      ConstructorDescription
      OutputReader​(java.io.InputStream source) +
      Create an OutputReader that reads from source.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethodDescription
      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, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, 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.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/StreamForwarder.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/StreamForwarder.html new file mode 100644 index 000000000..2b4bad44e --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/StreamForwarder.html @@ -0,0 +1,573 @@ + + + + + +StreamForwarder (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package 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 TypeFieldDescription
      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 
      ConstructorDescription
      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 TypeMethodDescription
      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, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, 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
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/package-summary.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/package-summary.html new file mode 100644 index 000000000..b1474f324 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/package-summary.html @@ -0,0 +1,197 @@ + + + + + +nl.esciencecenter.xenon.utils (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Package nl.esciencecenter.xenon.utils

+
+
+
+ + +
This package is contains several utility classes.
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    DaemonThreadFactory 
    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.
    +
    +
    • +
+
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/package-tree.html b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/package-tree.html new file mode 100644 index 000000000..2eaec67a3 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/nl/esciencecenter/xenon/utils/package-tree.html @@ -0,0 +1,174 @@ + + + + + +nl.esciencecenter.xenon.utils Class Hierarchy (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package nl.esciencecenter.xenon.utils

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/docs/versions/3.0.1/javadoc-devel/overview-summary.html b/docs/versions/3.0.1/javadoc-devel/overview-summary.html new file mode 100644 index 000000000..2cfb557d5 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/overview-summary.html @@ -0,0 +1,23 @@ + + + + + +xenon 3.0.1 API for Xenon developers + + + + + + + +
+ +

index.html

+
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/overview-tree.html b/docs/versions/3.0.1/javadoc-devel/overview-tree.html new file mode 100644 index 000000000..5cb913d5a --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/overview-tree.html @@ -0,0 +1,394 @@ + + + + + +Class Hierarchy (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Enum Hierarchy

+ +
+
+
+
+ +
+ + diff --git a/docs/versions/3.0.1/javadoc-devel/package-search-index.js b/docs/versions/3.0.1/javadoc-devel/package-search-index.js new file mode 100644 index 000000000..40ad4dad1 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","url":"allpackages-index.html"},{"l":"nl.esciencecenter.xenon"},{"l":"nl.esciencecenter.xenon.adaptors"},{"l":"nl.esciencecenter.xenon.adaptors.filesystems"},{"l":"nl.esciencecenter.xenon.adaptors.filesystems.ftp"},{"l":"nl.esciencecenter.xenon.adaptors.filesystems.local"},{"l":"nl.esciencecenter.xenon.adaptors.filesystems.sftp"},{"l":"nl.esciencecenter.xenon.adaptors.filesystems.webdav"},{"l":"nl.esciencecenter.xenon.adaptors.schedulers"},{"l":"nl.esciencecenter.xenon.adaptors.schedulers.at"},{"l":"nl.esciencecenter.xenon.adaptors.schedulers.gridengine"},{"l":"nl.esciencecenter.xenon.adaptors.schedulers.local"},{"l":"nl.esciencecenter.xenon.adaptors.schedulers.slurm"},{"l":"nl.esciencecenter.xenon.adaptors.schedulers.ssh"},{"l":"nl.esciencecenter.xenon.adaptors.schedulers.torque"},{"l":"nl.esciencecenter.xenon.adaptors.shared.ssh"},{"l":"nl.esciencecenter.xenon.credentials"},{"l":"nl.esciencecenter.xenon.filesystems"},{"l":"nl.esciencecenter.xenon.schedulers"},{"l":"nl.esciencecenter.xenon.utils"}] \ No newline at end of file diff --git a/docs/versions/3.0.1/javadoc-devel/package-search-index.zip b/docs/versions/3.0.1/javadoc-devel/package-search-index.zip new file mode 100644 index 000000000..a841d066c Binary files /dev/null and b/docs/versions/3.0.1/javadoc-devel/package-search-index.zip differ diff --git a/docs/versions/3.0.1/javadoc-devel/resources/glass.png b/docs/versions/3.0.1/javadoc-devel/resources/glass.png new file mode 100644 index 000000000..a7f591f46 Binary files /dev/null and b/docs/versions/3.0.1/javadoc-devel/resources/glass.png differ diff --git a/docs/versions/3.0.1/javadoc-devel/resources/x.png b/docs/versions/3.0.1/javadoc-devel/resources/x.png new file mode 100644 index 000000000..30548a756 Binary files /dev/null and b/docs/versions/3.0.1/javadoc-devel/resources/x.png differ diff --git a/docs/versions/3.0.1/javadoc-devel/script.js b/docs/versions/3.0.1/javadoc-devel/script.js new file mode 100644 index 000000000..0eaaf5358 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/script.js @@ -0,0 +1,139 @@ +/* + * Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; +function loadScripts(doc, tag) { + createElem(doc, tag, 'jquery/jszip/dist/jszip.js'); + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils.js'); + if (window.navigator.userAgent.indexOf('MSIE ') > 0 || window.navigator.userAgent.indexOf('Trident/') > 0 || + window.navigator.userAgent.indexOf('Edge/') > 0) { + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils-ie.js'); + } + createElem(doc, tag, 'search.js'); + + $.get(pathtoroot + "module-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "module-search-index.zip", function(e, data) { + var zip = new JSZip(data); + zip.load(data); + moduleSearchIndex = JSON.parse(zip.file("module-search-index.json").asText()); + }); + }); + $.get(pathtoroot + "package-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "package-search-index.zip", function(e, data) { + var zip = new JSZip(data); + zip.load(data); + packageSearchIndex = JSON.parse(zip.file("package-search-index.json").asText()); + }); + }); + $.get(pathtoroot + "type-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "type-search-index.zip", function(e, data) { + var zip = new JSZip(data); + zip.load(data); + typeSearchIndex = JSON.parse(zip.file("type-search-index.json").asText()); + }); + }); + $.get(pathtoroot + "member-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "member-search-index.zip", function(e, data) { + var zip = new JSZip(data); + zip.load(data); + memberSearchIndex = JSON.parse(zip.file("member-search-index.json").asText()); + }); + }); + $.get(pathtoroot + "tag-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "tag-search-index.zip", function(e, data) { + var zip = new JSZip(data); + zip.load(data); + tagSearchIndex = JSON.parse(zip.file("tag-search-index.json").asText()); + }); + }); + if (!moduleSearchIndex) { + createElem(doc, tag, 'module-search-index.js'); + } + if (!packageSearchIndex) { + createElem(doc, tag, 'package-search-index.js'); + } + if (!typeSearchIndex) { + createElem(doc, tag, 'type-search-index.js'); + } + if (!memberSearchIndex) { + createElem(doc, tag, 'member-search-index.js'); + } + if (!tagSearchIndex) { + createElem(doc, tag, 'tag-search-index.js'); + } + $(window).resize(function() { + $('.navPadding').css('padding-top', $('.fixedNav').css("height")); + }); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +function show(type) { + count = 0; + for (var key in data) { + var row = document.getElementById(key); + if ((data[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] + ""; + } + } +} + +function updateModuleFrame(pFrame, cFrame) { + top.packageFrame.location = pFrame; + top.classFrame.location = cFrame; +} diff --git a/docs/versions/3.0.1/javadoc-devel/search.js b/docs/versions/3.0.1/javadoc-devel/search.js new file mode 100644 index 000000000..9d3fb8122 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/search.js @@ -0,0 +1,329 @@ +/* + * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var noResult = {l: "No results found"}; +var catModules = "Modules"; +var catPackages = "Packages"; +var catTypes = "Types"; +var catMembers = "Members"; +var catSearchTags = "SearchTags"; +var highlight = "$&"; +var camelCaseRegexp = ""; +var secondaryMatcher = ""; +function getHighlightedText(item) { + var ccMatcher = new RegExp(camelCaseRegexp); + var label = item.replace(ccMatcher, highlight); + if (label === item) { + label = item.replace(secondaryMatcher, highlight); + } + return label; +} +function getURLPrefix(ui) { + var urlPrefix=""; + if (useModuleDirectories) { + var slash = "/"; + if (ui.item.category === catModules) { + return ui.item.l + slash; + } else if (ui.item.category === catPackages && ui.item.m) { + return ui.item.m + slash; + } else if ((ui.item.category === catTypes && ui.item.p) || ui.item.category === catMembers) { + $.each(packageSearchIndex, function(index, item) { + if (ui.item.p == item.l) { + urlPrefix = item.m + slash; + } + }); + return urlPrefix; + } else { + return urlPrefix; + } + } + return urlPrefix; +} +var watermark = 'Search'; +$(function() { + $("#search").val(''); + $("#search").prop("disabled", false); + $("#reset").prop("disabled", false); + $("#search").val(watermark).addClass('watermark'); + $("#search").blur(function() { + if ($(this).val().length == 0) { + $(this).val(watermark).addClass('watermark'); + } + }); + $("#search").on('click keydown', function() { + if ($(this).val() == watermark) { + $(this).val('').removeClass('watermark'); + } + }); + $("#reset").click(function() { + $("#search").val(''); + $("#search").focus(); + }); + $("#search").focus(); + $("#search")[0].setSelectionRange(0, 0); +}); +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)"); + }, + _renderMenu: function(ul, items) { + var rMenu = this, + currentCategory = ""; + $.each(items, function(index, item) { + var li; + if (item.l !== noResult.l && item.category !== currentCategory) { + ul.append("
  • " + item.category + "
    • "); + currentCategory = item.category; + } + li = rMenu._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", item.category + " : " + item.l); + li.attr("class", "resultItem"); + } else { + li.attr("aria-label", item.l); + li.attr("class", "resultItem"); + } + }); + }, + _renderItem: function(ul, item) { + var label = ""; + if (item.category === catModules) { + label = getHighlightedText(item.l); + } else if (item.category === catPackages) { + label = (item.m) + ? getHighlightedText(item.m + "/" + item.l) + : getHighlightedText(item.l); + } else if (item.category === catTypes) { + label = (item.p) + ? getHighlightedText(item.p + "." + item.l) + : getHighlightedText(item.l); + } else if (item.category === catMembers) { + label = getHighlightedText(item.p + "." + (item.c + "." + item.l)); + } else if (item.category === catSearchTags) { + label = getHighlightedText(item.l); + } else { + label = item.l; + } + $li = $("
  • ").appendTo(ul); + if (item.category === catSearchTags) { + if (item.d) { + $("").attr("href", "#") + .html(label + " (" + item.h + ")
    " + + item.d + "
    ") + .appendTo($li); + } else { + $("    ").attr("href", "#") + .html(label + " (" + item.h + ")") + .appendTo($li); + } + } else { + $("").attr("href", "#") + .html(label) + .appendTo($li); + } + return $li; + } +}); +$(function() { + $("#search").catcomplete({ + minLength: 1, + delay: 100, + source: function(request, response) { + var result = new Array(); + var presult = new Array(); + var tresult = new Array(); + var mresult = new Array(); + var tgresult = new Array(); + var secondaryresult = new Array(); + var displayCount = 0; + var exactMatcher = new RegExp("^" + $.ui.autocomplete.escapeRegex(request.term) + "$", "i"); + camelCaseRegexp = ($.ui.autocomplete.escapeRegex(request.term)).split(/(?=[A-Z])/).join("([a-z0-9_$]*?)"); + var camelCaseMatcher = new RegExp("^" + camelCaseRegexp); + secondaryMatcher = new RegExp($.ui.autocomplete.escapeRegex(request.term), "i"); + + // Return the nested innermost name from the specified object + function nestedName(e) { + return e.l.substring(e.l.lastIndexOf(".") + 1); + } + + function concatResults(a1, a2) { + a1 = a1.concat(a2); + a2.length = 0; + return a1; + } + + if (moduleSearchIndex) { + var mdleCount = 0; + $.each(moduleSearchIndex, function(index, item) { + item.category = catModules; + if (exactMatcher.test(item.l)) { + result.push(item); + mdleCount++; + } else if (camelCaseMatcher.test(item.l)) { + result.push(item); + } else if (secondaryMatcher.test(item.l)) { + secondaryresult.push(item); + } + }); + displayCount = mdleCount; + result = concatResults(result, secondaryresult); + } + if (packageSearchIndex) { + var pCount = 0; + var pkg = ""; + $.each(packageSearchIndex, function(index, item) { + item.category = catPackages; + pkg = (item.m) + ? (item.m + "/" + item.l) + : item.l; + if (exactMatcher.test(item.l)) { + presult.push(item); + pCount++; + } else if (camelCaseMatcher.test(pkg)) { + presult.push(item); + } else if (secondaryMatcher.test(pkg)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(presult, secondaryresult)); + displayCount = (pCount > displayCount) ? pCount : displayCount; + } + if (typeSearchIndex) { + var tCount = 0; + $.each(typeSearchIndex, function(index, item) { + item.category = catTypes; + var s = nestedName(item); + if (exactMatcher.test(s)) { + tresult.push(item); + tCount++; + } else if (camelCaseMatcher.test(s)) { + tresult.push(item); + } else if (secondaryMatcher.test(item.p + "." + item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(tresult, secondaryresult)); + displayCount = (tCount > displayCount) ? tCount : displayCount; + } + if (memberSearchIndex) { + var mCount = 0; + $.each(memberSearchIndex, function(index, item) { + item.category = catMembers; + var s = nestedName(item); + if (exactMatcher.test(s)) { + mresult.push(item); + mCount++; + } else if (camelCaseMatcher.test(s)) { + mresult.push(item); + } else if (secondaryMatcher.test(item.c + "." + item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(mresult, secondaryresult)); + displayCount = (mCount > displayCount) ? mCount : displayCount; + } + if (tagSearchIndex) { + var tgCount = 0; + $.each(tagSearchIndex, function(index, item) { + item.category = catSearchTags; + if (exactMatcher.test(item.l)) { + tgresult.push(item); + tgCount++; + } else if (secondaryMatcher.test(item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(tgresult, secondaryresult)); + displayCount = (tgCount > displayCount) ? tgCount : displayCount; + } + displayCount = (displayCount > 500) ? displayCount : 500; + var counter = function() { + var count = {Modules: 0, Packages: 0, Types: 0, Members: 0, SearchTags: 0}; + var f = function(item) { + count[item.category] += 1; + return (count[item.category] <= displayCount); + }; + return f; + }(); + response(result.filter(counter)); + }, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push(noResult); + } else { + $("#search").empty(); + } + }, + autoFocus: true, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.l !== noResult.l) { + var url = getURLPrefix(ui); + if (ui.item.category === catModules) { + if (useModuleDirectories) { + url += "module-summary.html"; + } else { + url = ui.item.l + "-summary.html"; + } + } else if (ui.item.category === catPackages) { + if (ui.item.url) { + url = ui.item.url; + } else { + url += ui.item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (ui.item.category === catTypes) { + if (ui.item.url) { + url = ui.item.url; + } else if (ui.item.p === "") { + url += ui.item.l + ".html"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.l + ".html"; + } + } else if (ui.item.category === catMembers) { + if (ui.item.p === "") { + url += ui.item.c + ".html" + "#"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#"; + } + if (ui.item.url) { + url += ui.item.url; + } else { + url += ui.item.l; + } + } else if (ui.item.category === catSearchTags) { + url += ui.item.u; + } + if (top !== window) { + parent.classFrame.location = pathtoroot + url; + } else { + window.location.href = pathtoroot + url; + } + } + } + }); +}); diff --git a/docs/versions/3.0.1/javadoc-devel/serialized-form.html b/docs/versions/3.0.1/javadoc-devel/serialized-form.html new file mode 100644 index 000000000..4e51ad637 --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/serialized-form.html @@ -0,0 +1,547 @@ + + + + + +Serialized Form (xenon 3.0.1 API for Xenon developers) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Serialized Form

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc-devel/stylesheet.css b/docs/versions/3.0.1/javadoc-devel/stylesheet.css new file mode 100644 index 000000000..fa246765c --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/stylesheet.css @@ -0,0 +1,906 @@ +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:#bb7a2a; +} +a[name] { + color:#353833; +} +a[name]:before, a[name]:target, a[id]:before, a[id]:target { + content:""; + display:inline-block; + position:relative; + padding-top:129px; + margin-top:-129px; +} +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; +} + +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.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; +} +/* + * Styles for navigation bar. + */ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.navPadding { + padding-top: 107px; +} +.fixedNav { + position:fixed; + width:100%; + z-index:999; + background-color:#ffffff; +} +.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.navListSearch { + float:right; + margin:0 0 0 0; + padding:0; +} +ul.navListSearch li { + list-style:none; + float:right; + padding: 5px 6px; + text-transform:uppercase; +} +ul.navListSearch li label { + position:relative; + right:-16px; +} +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; +} +/* + * Styles for page header and footer. + */ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexNav { + position:relative; + font-size:12px; + background-color:#dee3e9; +} +.indexNav ul { + margin-top:0; + padding:5px; +} +.indexNav ul li { + display:inline; + list-style-type:none; + padding-right:10px; + text-transform:uppercase; +} +.indexNav 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; +} +/* + * Styles for headings. + */ +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; +} +/* + * Styles for page layout containers. + */ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer, +.allClassesContainer, .allPackagesContainer { + 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 Serif', Georgia, "Times New Roman", Times, serif; +} +.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; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +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; +} +/* + * Styles for tables. + */ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary, +.requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + width:100%; + border-spacing:0; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary, .requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption, +.requiresSummary caption, .packagesSummary caption, .providesSummary caption, .usesSummary 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, +.constantsSummary caption a:link, .deprecatedSummary caption a:link, +.requiresSummary caption a:link, .packagesSummary caption a:link, .providesSummary caption a:link, +.usesSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.requiresSummary caption a:hover, .packagesSummary caption a:hover, .providesSummary caption a:hover, +.usesSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.constantsSummary caption a:active, .deprecatedSummary caption a:active, +.requiresSummary caption a:active, .packagesSummary caption a:active, .providesSummary caption a:active, +.usesSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.constantsSummary caption a:visited, .deprecatedSummary caption a:visited, +.requiresSummary caption a:visited, .packagesSummary caption a:visited, .providesSummary caption a:visited, +.usesSummary caption a:visited { + color:#FFFFFF; +} +.useSummary caption a:link, .useSummary caption a:hover, .useSummary caption a:active, +.useSummary caption a:visited { + color:#1f389c; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span, +.requiresSummary caption span, .packagesSummary caption span, .providesSummary caption span, +.usesSummary 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, .packagesSummary caption span.activeTableTab span, +.overviewSummary caption span.activeTableTab span, .typeSummary 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, .packagesSummary caption span.tableTab span, +.overviewSummary caption span.tableTab span, .typeSummary 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, +.packagesSummary caption span.tableTab, .packagesSummary caption span.activeTableTab, +.overviewSummary caption span.tableTab, .overviewSummary caption span.activeTableTab, +.typeSummary caption span.tableTab, .typeSummary 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, +.requiresSummary .tabEnd, .packagesSummary .tabEnd, .providesSummary .tabEnd, .usesSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd, .packagesSummary .activeTableTab .tabEnd, +.overviewSummary .activeTableTab .tabEnd, .typeSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd, .packagesSummary .tableTab .tabEnd, +.overviewSummary .tableTab .tabEnd, .typeSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; +} +.rowColor th, .altColor th { + font-weight:normal; +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td, +.requiresSummary td, .packagesSummary td, .providesSummary td, .usesSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .useSummary th, +.constantsSummary th, .packagesSummary th, td.colFirst, td.colSecond, td.colLast, .useSummary td, +.constantsSummary td { + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .constantsSummary th, +.packagesSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + font-size:13px; +} +td.colSecond, th.colSecond, td.colLast, th.colConstructorName, th.colDeprecatedItemName, th.colLast { + font-size:13px; +} +.constantsSummary th, .packagesSummary th { + font-size:13px; +} +.providesSummary th.colFirst, .providesSummary th.colLast, .providesSummary td.colFirst, +.providesSummary td.colLast { + white-space:normal; + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.requiresSummary td.colFirst, .requiresSummary th.colFirst, +.packagesSummary td.colFirst, .packagesSummary td.colSecond, .packagesSummary th.colFirst, .packagesSummary th, +.usesSummary td.colFirst, .usesSummary th.colFirst, +.providesSummary td.colFirst, .providesSummary th.colFirst, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colSecond, .memberSummary th.colSecond, .memberSummary th.colConstructorName, +.typeSummary td.colFirst, .typeSummary th.colFirst { + vertical-align:top; +} +.packagesSummary th.colLast, .packagesSummary td.colLast { + white-space:normal; +} +td.colFirst a:link, td.colFirst a:visited, +td.colSecond a:link, td.colSecond a:visited, +th.colFirst a:link, th.colFirst a:visited, +th.colSecond a:link, th.colSecond a:visited, +th.colConstructorName a:link, th.colConstructorName a:visited, +th.colDeprecatedItemName a:link, th.colDeprecatedItemName a:visited, +.constantValuesContainer td a:link, .constantValuesContainer td a:visited, +.allClassesContainer td a:link, .allClassesContainer td a:visited, +.allPackagesContainer td a:link, .allPackagesContainer td a:visited { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor, .altColor th { + background-color:#FFFFFF; +} +.rowColor, .rowColor th { + background-color:#EEEEEF; +} +/* + * Styles for contents. + */ +.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; +} +/* + * Styles for formatting effect. + */ +.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, .implementationLabel, .memberNameLabel, .memberNameLink, +.moduleLabelInPackage, .moduleLabelInType, .overrideSpecifyLabel, .packageLabelInType, +.packageHierarchyLabel, .paramLabel, .returnLabel, .seeLabel, .simpleTagLabel, +.throwsLabel, .typeNameLabel, .typeNameLink, .searchTagLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} +.deprecationBlock { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.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; +} +/* + * Styles for IFRAME. + */ +.mainContainer { + margin:0 auto; + padding:0; + height:100%; + width:100%; + position:fixed; + top:0; + left:0; +} +.leftContainer { + height:100%; + position:fixed; + width:320px; +} +.leftTop { + position:relative; + float:left; + width:315px; + top:0; + left:0; + height:30%; + border-right:6px solid #ccc; + border-bottom:6px solid #ccc; +} +.leftBottom { + position:relative; + float:left; + width:315px; + bottom:0; + left:0; + height:70%; + border-right:6px solid #ccc; + border-top:1px solid #000; +} +.rightContainer { + position:absolute; + left:320px; + top:0; + bottom:0; + height:100%; + right:0; + border-left:1px solid #000; +} +.rightIframe { + margin:0; + padding:0; + height:100%; + right:30px; + width:100%; + overflow:visible; + margin-bottom:30px; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:#4D7A97; + color:#FFFFFF; +} +.resultItem { + font-size:13px; +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:scroll; + overflow-x:scroll; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:999999; +} +ul.ui-autocomplete li { + float:left; + clear:both; + width:100%; +} +.resultHighlight { + font-weight:bold; +} +#search { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + padding-left:20px; + position:relative; + right:-18px; +} +#reset { + background-color: rgb(255,255,255); + background-image:url('resources/x.png'); + background-position:center; + background-repeat:no-repeat; + background-size:12px; + border:0 none; + width:16px; + height:17px; + position:relative; + left:-4px; + top:-4px; + font-size:0px; +} +.watermark { + color:#545454; +} +.searchTagDescResult { + font-style:italic; + font-size:11px; +} +.searchTagHolderResult { + font-style:italic; + font-size:12px; +} +.searchTagResult:before, .searchTagResult:target { + color:red; +} +.moduleGraph span { + display:none; + position:absolute; +} +.moduleGraph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.methodSignature { + white-space:normal; +} + +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid black; +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid black; +} +table.striped { + border-collapse: collapse; + border: 1px solid black; +} +table.striped > thead { + background-color: #E3E3E3; +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid black; +} +table.striped > tbody > tr:nth-child(even) { + background-color: #EEE +} +table.striped > tbody > tr:nth-child(odd) { + background-color: #FFF +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid black; + border-right: 1px solid black; +} +table.striped > tbody > tr > th { + font-weight: normal; +} diff --git a/docs/versions/3.0.1/javadoc-devel/type-search-index.js b/docs/versions/3.0.1/javadoc-devel/type-search-index.js new file mode 100644 index 000000000..954c83a8b --- /dev/null +++ b/docs/versions/3.0.1/javadoc-devel/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"p":"nl.esciencecenter.xenon.adaptors","l":"Adaptor"},{"p":"nl.esciencecenter.xenon","l":"AdaptorDescription"},{"p":"nl.esciencecenter.xenon.adaptors","l":"AdaptorLoader"},{"l":"All Classes","url":"allclasses-index.html"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.gridengine","l":"ParallelEnvironmentInfo.AllocationRule"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.at","l":"AtScheduler"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.at","l":"AtSchedulerAdaptor"},{"p":"nl.esciencecenter.xenon.filesystems","l":"AttributeNotSupportedException"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.at","l":"AtUtils"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"BadParameterException"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"BatchProcess"},{"p":"nl.esciencecenter.xenon.credentials","l":"CertificateCredential"},{"p":"nl.esciencecenter.xenon.adaptors.shared.ssh","l":"CertificateNotFoundException"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems.ftp","l":"FtpFileSystem.CloseableClient"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.local","l":"CommandNotFoundException"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.local","l":"CommandRunner"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems","l":"ConnectionLostException"},{"p":"nl.esciencecenter.xenon.filesystems","l":"FileSystem.CopyCallback"},{"p":"nl.esciencecenter.xenon.filesystems","l":"CopyCancelledException"},{"p":"nl.esciencecenter.xenon.filesystems","l":"CopyMode"},{"p":"nl.esciencecenter.xenon.filesystems","l":"CopyStatus"},{"p":"nl.esciencecenter.xenon.filesystems","l":"FileSystem.CopyStatusImplementation"},{"p":"nl.esciencecenter.xenon.credentials","l":"Credential"},{"p":"nl.esciencecenter.xenon.credentials","l":"CredentialMap"},{"p":"nl.esciencecenter.xenon.adaptors.shared.ssh","l":"CredentialNotFoundException"},{"p":"nl.esciencecenter.xenon.utils","l":"DaemonThreadFactory"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"Deadline"},{"p":"nl.esciencecenter.xenon.credentials","l":"DefaultCredential"},{"p":"nl.esciencecenter.xenon.filesystems","l":"DirectoryNotEmptyException"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems","l":"EndOfFileException"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems","l":"FileAdaptor"},{"p":"nl.esciencecenter.xenon.filesystems","l":"FileSystem"},{"p":"nl.esciencecenter.xenon.filesystems","l":"FileSystemAdaptorDescription"},{"p":"nl.esciencecenter.xenon.filesystems","l":"FileSystemClosedException"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems.ftp","l":"FtpFileAdaptor"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems.ftp","l":"FtpFileSystem"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.gridengine","l":"GridEngineScheduler"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.gridengine","l":"GridEngineSchedulerAdaptor"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.gridengine","l":"GridEngineSetup"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.gridengine","l":"GridEngineUtils"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.gridengine","l":"GridEngineXmlParser"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"IncompatibleVersionException"},{"p":"nl.esciencecenter.xenon.schedulers","l":"IncompleteJobDescriptionException"},{"p":"nl.esciencecenter.xenon.utils","l":"InputWriter"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"InteractiveProcess"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"InteractiveProcessFactory"},{"p":"nl.esciencecenter.xenon","l":"InvalidCredentialException"},{"p":"nl.esciencecenter.xenon.schedulers","l":"InvalidJobDescriptionException"},{"p":"nl.esciencecenter.xenon","l":"InvalidLocationException"},{"p":"nl.esciencecenter.xenon.filesystems","l":"InvalidOptionsException"},{"p":"nl.esciencecenter.xenon.filesystems","l":"InvalidPathException"},{"p":"nl.esciencecenter.xenon","l":"InvalidPropertyException"},{"p":"nl.esciencecenter.xenon.filesystems","l":"InvalidResumeTargetException"},{"p":"nl.esciencecenter.xenon.utils","l":"JavaJobDescription"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"JobCanceledException"},{"p":"nl.esciencecenter.xenon.schedulers","l":"JobDescription"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"JobExecutor"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"JobQueueScheduler"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"JobSeenMap"},{"p":"nl.esciencecenter.xenon.schedulers","l":"JobStatus"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"JobStatusImplementation"},{"p":"nl.esciencecenter.xenon.credentials","l":"KeytabCredential"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems.local","l":"LocalFileAdaptor"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems.local","l":"LocalFileSystem"},{"p":"nl.esciencecenter.xenon.utils","l":"LocalFileSystemUtils"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.local","l":"LocalInteractiveProcess"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.local","l":"LocalInteractiveProcessFactory"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.local","l":"LocalSchedulerAdaptor"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems","l":"NoSpaceException"},{"p":"nl.esciencecenter.xenon.filesystems","l":"NoSuchCopyException"},{"p":"nl.esciencecenter.xenon.schedulers","l":"NoSuchJobException"},{"p":"nl.esciencecenter.xenon.filesystems","l":"NoSuchPathException"},{"p":"nl.esciencecenter.xenon.schedulers","l":"NoSuchQueueException"},{"p":"nl.esciencecenter.xenon.adaptors","l":"NotConnectedException"},{"p":"nl.esciencecenter.xenon.utils","l":"OutputReader"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.gridengine","l":"ParallelEnvironmentInfo"},{"p":"nl.esciencecenter.xenon.credentials","l":"PasswordCredential"},{"p":"nl.esciencecenter.xenon.adaptors.shared.ssh","l":"SSHUtil.PasswordProvider"},{"p":"nl.esciencecenter.xenon.filesystems","l":"Path"},{"p":"nl.esciencecenter.xenon.filesystems","l":"PathAlreadyExistsException"},{"p":"nl.esciencecenter.xenon.filesystems","l":"PathAttributes"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems","l":"PathAttributesImplementation"},{"p":"nl.esciencecenter.xenon.filesystems","l":"Path.PathIterator"},{"p":"nl.esciencecenter.xenon.filesystems","l":"FileSystem.PendingCopy"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems","l":"PermissionDeniedException"},{"p":"nl.esciencecenter.xenon.filesystems","l":"PosixFilePermission"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems","l":"PosixFileUtils"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"Process"},{"p":"nl.esciencecenter.xenon","l":"PropertyTypeException"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.gridengine","l":"QueueInfo"},{"p":"nl.esciencecenter.xenon.schedulers","l":"QueueStatus"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"QueueStatusImplementation"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems","l":"RecursiveListIterator"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"RemoteCommandRunner"},{"p":"nl.esciencecenter.xenon.schedulers","l":"Scheduler"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"SchedulerAdaptor"},{"p":"nl.esciencecenter.xenon.schedulers","l":"SchedulerAdaptorDescription"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"SchedulerClosedException"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"ScriptingParser"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"ScriptingScheduler"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"ScriptingSchedulerAdaptor"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"ScriptingUtils"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems.sftp","l":"SftpFileAdaptor"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems.sftp","l":"SftpFileSystem"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.slurm","l":"SlurmScheduler"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.slurm","l":"SlurmSchedulerAdaptor"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.slurm","l":"SlurmSetup"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.slurm","l":"SlurmUtils"},{"p":"nl.esciencecenter.xenon.adaptors.shared.ssh","l":"SSHConnection"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.ssh","l":"SshInteractiveProcess"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.ssh","l":"SshInteractiveProcessFactory"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.ssh","l":"SshSchedulerAdaptor"},{"p":"nl.esciencecenter.xenon.adaptors.shared.ssh","l":"SSHUtil"},{"p":"nl.esciencecenter.xenon.utils","l":"StreamForwarder"},{"p":"nl.esciencecenter.xenon.schedulers","l":"Streams"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers","l":"StreamsImplementation"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems.webdav","l":"WebdavFileSystem.StreamToFileWriter"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.torque","l":"TorqueScheduler"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.torque","l":"TorqueSchedulerAdaptor"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.torque","l":"TorqueUtils"},{"p":"nl.esciencecenter.xenon.adaptors.schedulers.torque","l":"TorqueXmlParser"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems","l":"TransferClientInputStream"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems","l":"TransferClientOutputStream"},{"p":"nl.esciencecenter.xenon.adaptors.shared.ssh","l":"SSHUtil.Tunnel"},{"p":"nl.esciencecenter.xenon","l":"XenonPropertyDescription.Type"},{"p":"nl.esciencecenter.xenon","l":"UnknownAdaptorException"},{"p":"nl.esciencecenter.xenon","l":"UnknownPropertyException"},{"p":"nl.esciencecenter.xenon.schedulers","l":"UnsupportedJobDescriptionException"},{"p":"nl.esciencecenter.xenon","l":"UnsupportedOperationException"},{"p":"nl.esciencecenter.xenon.credentials","l":"UserCredential"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems.webdav","l":"WebdavFileAdaptor"},{"p":"nl.esciencecenter.xenon.adaptors.filesystems.webdav","l":"WebdavFileSystem"},{"p":"nl.esciencecenter.xenon","l":"XenonException"},{"p":"nl.esciencecenter.xenon.adaptors","l":"XenonProperties"},{"p":"nl.esciencecenter.xenon","l":"XenonPropertyDescription"},{"p":"nl.esciencecenter.xenon","l":"XenonRuntimeException"}] \ No newline at end of file diff --git a/docs/versions/3.0.1/javadoc-devel/type-search-index.zip b/docs/versions/3.0.1/javadoc-devel/type-search-index.zip new file mode 100644 index 000000000..f64c78004 Binary files /dev/null and b/docs/versions/3.0.1/javadoc-devel/type-search-index.zip differ diff --git a/docs/versions/3.0.1/javadoc/allclasses-index.html b/docs/versions/3.0.1/javadoc/allclasses-index.html new file mode 100644 index 000000000..ae7d6e216 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/allclasses-index.html @@ -0,0 +1,469 @@ + + + + + +All Classes (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    All Classes

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/allclasses.html b/docs/versions/3.0.1/javadoc/allclasses.html new file mode 100644 index 000000000..4f0336c7b --- /dev/null +++ b/docs/versions/3.0.1/javadoc/allclasses.html @@ -0,0 +1,80 @@ + + + + + +All Classes (xenon 3.0.1 API) + + + + + + + + + + + + +

    All Classes

    +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/allpackages-index.html b/docs/versions/3.0.1/javadoc/allpackages-index.html new file mode 100644 index 000000000..c5a1141e9 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/allpackages-index.html @@ -0,0 +1,190 @@ + + + + + +All Packages (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    All Packages

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/constant-values.html b/docs/versions/3.0.1/javadoc/constant-values.html new file mode 100644 index 000000000..4a2ec9d17 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/constant-values.html @@ -0,0 +1,200 @@ + + + + + +Constant Field Values (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Constant Field Values

    +
    +

    Contents

    + +
    +
    +
    + + +
    +

    nl.esciencecenter.*

    +
      +
    • + + + + + + + + + + + + + + +
      nl.esciencecenter.xenon.filesystems.Path 
      Modifier and TypeConstant FieldValue
      + +public static final charDEFAULT_SEPARATOR47
      +
      • +
    +
      +
    • + + + + + + + + + + + + + + +
      nl.esciencecenter.xenon.schedulers.JobDescription 
      Modifier and TypeConstant FieldValue
      + +public static final java.lang.StringDEFAULT_START_TIME"now"
      +
      • +
    +
    +
    +
    +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/deprecated-list.html b/docs/versions/3.0.1/javadoc/deprecated-list.html new file mode 100644 index 000000000..9140d6ae1 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/deprecated-list.html @@ -0,0 +1,146 @@ + + + + + +Deprecated List (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Deprecated API

    +

    Contents

    +
    +
    +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/element-list b/docs/versions/3.0.1/javadoc/element-list new file mode 100644 index 000000000..9cbac2f80 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/element-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/3.0.1/javadoc/help-doc.html b/docs/versions/3.0.1/javadoc/help-doc.html new file mode 100644 index 000000000..33523e83a --- /dev/null +++ b/docs/versions/3.0.1/javadoc/help-doc.html @@ -0,0 +1,272 @@ + + + + + +API Help (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    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. These pages may contain six categories:

      +
        +
      • Interfaces
        • +
      • Classes
        • +
      • Enums
        • +
      • Exceptions
        • +
      • Errors
        • +
      • Annotation Types
        • +
      +
      +
      • +
    • +
      +

      Class or 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 or Interface Declaration
        • +
      • Class or Interface Description
        • +
      +
      +
        +
      • Nested Class Summary
        • +
      • Field Summary
        • +
      • Property Summary
        • +
      • Constructor Summary
        • +
      • Method Summary
        • +
      +
      +
        +
      • Field Detail
        • +
      • Property 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. Classes are organized by inheritance structure starting with java.lang.Object. 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 on "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 index of all classes, interfaces, constructors, methods, and fields, as well as lists of all packages and all classes.

      +
      +
      • +
    • +
      +

      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.

      +
      +
      • +
    • +
      +

      Search

      +

      You can search for definitions of modules, packages, types, fields, methods and other terms defined in the API, using some or all of the name. "Camel-case" abbreviations are supported: for example, "InpStr" will find "InputStream" and "InputStreamReader".

      +
      +
      • +
    +
    +This help file applies to API documentation generated by the standard doclet.
    +
    +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/index-all.html b/docs/versions/3.0.1/javadoc/index-all.html new file mode 100644 index 000000000..fbef27185 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/index-all.html @@ -0,0 +1,1835 @@ + + + + + +Index (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    A B C D E F G H I J K L M N O P Q R S T U V W X 
    All Classes All Packages + + +

    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.
    +
    +
    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) - Constructor for exception nl.esciencecenter.xenon.filesystems.AttributeNotSupportedException
    +
     
    +
    AttributeNotSupportedException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.AttributeNotSupportedException
    +
     
    +
    + + + +

    B

    +
    +
    BOOLEAN - nl.esciencecenter.xenon.XenonPropertyDescription.Type
    +
    +
    Properties of type BOOLEAN can be either "true" or "false".
    +
    +
    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.
    +
    +
    convertFromOctal(String) - Static method in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
    +
     
    +
    convertToOctal(Set<PosixFilePermission>) - Static method in enum nl.esciencecenter.xenon.filesystems.PosixFilePermission
    +
     
    +
    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) - 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) - 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.
    +
    +
    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, 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, 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, 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, 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, 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 - nl.esciencecenter.xenon.filesystems.CopyMode
    +
    +
    Copy to a new destination file, failing if the file already exists.
    +
    +
    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

    +
    +
    DaemonThreadFactory - Class in nl.esciencecenter.xenon.utils
    +
     
    +
    DaemonThreadFactory(String) - Constructor for class nl.esciencecenter.xenon.utils.DaemonThreadFactory
    +
     
    +
    DEFAULT_SEPARATOR - Static variable in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    The default separator to use.
    +
    +
    DEFAULT_START_TIME - Static variable in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    The default start time
    +
    +
    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) - Constructor for exception nl.esciencecenter.xenon.filesystems.DirectoryNotEmptyException
    +
     
    +
    DirectoryNotEmptyException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.filesystems.DirectoryNotEmptyException
    +
     
    +
    DOUBLE - nl.esciencecenter.xenon.XenonPropertyDescription.Type
    +
    +
    Properties of type DOUBLE can be converted into a 64-bit floating point number using Double.valueOf(String).
    +
    +
    + + + +

    E

    +
    +
    endsWith(String) - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Tests if this Path ends with the given Path represented as a String.
    +
    +
    endsWith(Path) - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Tests if this Path ends with the given Path.
    +
    +
    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) - Constructor for exception nl.esciencecenter.xenon.filesystems.FileSystemClosedException
    +
     
    +
    FileSystemClosedException(String, String, Throwable) - 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.
    +
    +
    getCoresPerTask() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Get the number of cores needed for each task.
    +
    +
    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.
    +
    +
    getDefaultRuntime() - Method in class nl.esciencecenter.xenon.schedulers.Scheduler
    +
    +
    Get the default runtime of a job in minutes.
    +
    +
    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.
    +
    +
    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() - 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.
    +
    +
    getName(int) - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Get an element of this Path.
    +
    +
    getNameCount() - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Get the number of elements in the Path.
    +
    +
    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).
    +
    +
    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.
    +
    +
    getStartTime() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Get the start time of the job.
    +
    +
    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.
    +
    +
    getTasks() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Get the number of tasks in this job.
    +
    +
    getTasksPerNode() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Get the number of tasks per node.
    +
    +
    getTempSpace() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Get the amount of temp space needed for process (in MBytes).
    +
    +
    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.
    +
    +
    GROUP_EXECUTE - nl.esciencecenter.xenon.filesystems.PosixFilePermission
    +
    +
    Execute/search permission, group.
    +
    +
    GROUP_READ - nl.esciencecenter.xenon.filesystems.PosixFilePermission
    +
    +
    Read permission, group.
    +
    +
    GROUP_WRITE - nl.esciencecenter.xenon.filesystems.PosixFilePermission
    +
    +
    Write permission, group.
    +
    +
    + + + +

    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

    +
    +
    IGNORE - nl.esciencecenter.xenon.filesystems.CopyMode
    +
    +
    Skip the copy if the destination file if it already exists.
    +
    +
    IncompleteJobDescriptionException - Exception in nl.esciencecenter.xenon.schedulers
    +
    +
    Signals that a JobDescription is missing required options.
    +
    +
    IncompleteJobDescriptionException(String, String) - Constructor for exception nl.esciencecenter.xenon.schedulers.IncompleteJobDescriptionException
    +
     
    +
    IncompleteJobDescriptionException(String, String, Throwable) - 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.
    +
    +
    INTEGER - nl.esciencecenter.xenon.XenonPropertyDescription.Type
    +
    +
    Properties of type INTEGER can be converted into a 32-bit signed integer using Integer.valueOf(String).
    +
    +
    InvalidCredentialException - Exception in nl.esciencecenter.xenon
    +
    +
    Signals that an invalid credential was used to access a resource.
    +
    +
    InvalidCredentialException(String, String) - Constructor for exception nl.esciencecenter.xenon.InvalidCredentialException
    +
     
    +
    InvalidCredentialException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.schedulers.InvalidJobDescriptionException
    +
     
    +
    InvalidJobDescriptionException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.schedulers.InvalidJobDescriptionException
    +
     
    +
    InvalidLocationException - Exception in nl.esciencecenter.xenon
    +
    +
    Signals that an invalid location was provided.
    +
    +
    InvalidLocationException(String, String) - Constructor for exception nl.esciencecenter.xenon.InvalidLocationException
    +
     
    +
    InvalidLocationException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.filesystems.InvalidOptionsException
    +
     
    +
    InvalidOptionsException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.filesystems.InvalidPathException
    +
     
    +
    InvalidPathException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.InvalidPropertyException
    +
     
    +
    InvalidPropertyException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.filesystems.InvalidResumeTargetException
    +
     
    +
    InvalidResumeTargetException(String, String, Throwable) - 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.
    +
    +
    isStartPerJob() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Will the executable be started per job? + + true by default.
    +
    +
    isStartPerTask() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Will the executable be started per task? + + false by default.
    +
    +
    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
    +
     
    +
    LONG - nl.esciencecenter.xenon.XenonPropertyDescription.Type
    +
    +
    Properties of type LONG can be converted into a 64-bit signed long using Long.valueOf(String).
    +
    +
    + + + +

    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

    +
    +
    NATURAL - nl.esciencecenter.xenon.XenonPropertyDescription.Type
    +
    +
    Properties of type NATURAL may contain only positive values, including 0.
    +
    +
    needsSizeBeforehand() - Method in interface nl.esciencecenter.xenon.filesystems.FileSystemAdaptorDescription
    +
     
    +
    newThread(Runnable) - Method in class nl.esciencecenter.xenon.utils.DaemonThreadFactory
    +
     
    +
    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) - Constructor for exception nl.esciencecenter.xenon.filesystems.NoSuchCopyException
    +
     
    +
    NoSuchCopyException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.schedulers.NoSuchJobException
    +
     
    +
    NoSuchJobException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.filesystems.NoSuchPathException
    +
     
    +
    NoSuchPathException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.schedulers.NoSuchQueueException
    +
     
    +
    NoSuchQueueException(String, String, Throwable) - Constructor for exception nl.esciencecenter.xenon.schedulers.NoSuchQueueException
    +
     
    +
    + + + +

    O

    +
    +
    OTHERS_EXECUTE - nl.esciencecenter.xenon.filesystems.PosixFilePermission
    +
    +
    Execute/search permission, others.
    +
    +
    OTHERS_READ - nl.esciencecenter.xenon.filesystems.PosixFilePermission
    +
    +
    Read permission, others.
    +
    +
    OTHERS_WRITE - nl.esciencecenter.xenon.filesystems.PosixFilePermission
    +
    +
    Write permission, others.
    +
    +
    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.
    +
    +
    OWNER_EXECUTE - nl.esciencecenter.xenon.filesystems.PosixFilePermission
    +
    +
    Execute/search permission, owner.
    +
    +
    OWNER_READ - nl.esciencecenter.xenon.filesystems.PosixFilePermission
    +
    +
    Read permission, owner.
    +
    +
    OWNER_WRITE - nl.esciencecenter.xenon.filesystems.PosixFilePermission
    +
    +
    Write permission, owner.
    +
    +
    + + + +

    P

    +
    +
    PasswordCredential - Class in nl.esciencecenter.xenon.credentials
    +
    +
    A Credential consisting of a username + password combination.
    +
    +
    PasswordCredential(String, char[]) - Constructor for class nl.esciencecenter.xenon.credentials.PasswordCredential
    +
    +
    Create a new PasswordCredential using a char array as password.
    +
    +
    PasswordCredential(String, String) - Constructor for class nl.esciencecenter.xenon.credentials.PasswordCredential
    +
    +
    Create a new PasswordCredential using a String 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(boolean, String...) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Create a new Path using the given path elements and the default 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, String...) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Create a new Path using the given path elements and the provided 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(char, String) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Create a new Path by parsing path using the provided separator.
    +
    +
    Path(String) - Constructor for class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Create a new Path by parsing path using the default separator.
    +
    +
    PathAlreadyExistsException - Exception in nl.esciencecenter.xenon.filesystems
    +
    +
    Signals that a path already exists.
    +
    +
    PathAlreadyExistsException(String, String) - Constructor for exception nl.esciencecenter.xenon.filesystems.PathAlreadyExistsException
    +
     
    +
    PathAlreadyExistsException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.PropertyTypeException
    +
     
    +
    PropertyTypeException(String, String, Throwable) - 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).
    +
    +
    REPLACE - nl.esciencecenter.xenon.filesystems.CopyMode
    +
    +
    If the source and destination are a regular file, the destination file will be replaced.
    +
    +
    resolve(String) - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Resolve a Path represented as a String against this path.
    +
    +
    resolve(Path) - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Resolve a Path 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.
    +
    +
    setCoresPerTask(int) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Set the number of cores needed for each task.
    +
    +
    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.
    +
    +
    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.
    +
    +
    setPosixFilePermissions(Path, Set<PosixFilePermission>) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Sets the POSIX permissions of a path (optional operation).
    +
    +
    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.
    +
    +
    setStartPerJob() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Set if the executable must be started for once per job instead of for each task.
    +
    +
    setStartPerTask() - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Set if the executable must be started for each task instead of once per job.
    +
    +
    setStartTime(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Set the start time of the job.
    +
    +
    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.
    +
    +
    setTasks(int) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Set the number of tasks in this job.
    +
    +
    setTasksPerNode(int) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Set the number of tasks allowed per node.
    +
    +
    setTempSpace(int) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Set the amount of memory needed for process (in MBytes).
    +
    +
    setWorkingDirectory(String) - Method in class nl.esciencecenter.xenon.schedulers.JobDescription
    +
    +
    Sets the path of the working directory for the executable.
    +
    +
    setWorkingDirectory(Path) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Set the current working directory of this file system to directory.
    +
    +
    SIZE - nl.esciencecenter.xenon.XenonPropertyDescription.Type
    +
    +
    Properties of type SIZE can be converted into a 64-bit signed long using Long.valueOf(String).
    +
    +
    startsWith(String) - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Tests if this Path starts with the given Path represented as a String.
    +
    +
    startsWith(Path) - Method in class nl.esciencecenter.xenon.filesystems.Path
    +
    +
    Tests if this Path starts with the given Path.
    +
    +
    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(InputStream, OutputStream) - Constructor for class nl.esciencecenter.xenon.utils.StreamForwarder
    +
    +
    Create a new StreamForwarder and start it immediately.
    +
    +
    StreamForwarder(String, InputStream, OutputStream, int) - 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.
    +
    +
    STRING - nl.esciencecenter.xenon.XenonPropertyDescription.Type
    +
    +
    Properties of type STRING are directly stored in a String without conversion.
    +
    +
    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) - Constructor for exception nl.esciencecenter.xenon.UnknownAdaptorException
    +
     
    +
    UnknownAdaptorException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.UnknownPropertyException
    +
     
    +
    UnknownPropertyException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.schedulers.UnsupportedJobDescriptionException
    +
     
    +
    UnsupportedJobDescriptionException(String, String, Throwable) - 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) - Constructor for exception nl.esciencecenter.xenon.UnsupportedOperationException
    +
     
    +
    UnsupportedOperationException(String, String, Throwable) - 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) - Method in class nl.esciencecenter.xenon.filesystems.FileSystem
    +
    +
    Open a file and return an OutputStream to write to this file.
    +
    +
    writeToFile(Path, long) - 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 
    All Classes All Packages
    +
    +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/index.html b/docs/versions/3.0.1/javadoc/index.html new file mode 100644 index 000000000..ab45f462e --- /dev/null +++ b/docs/versions/3.0.1/javadoc/index.html @@ -0,0 +1,791 @@ + + + + + +Overview (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +

    xenon 3.0.1 API

    +
    +
    +
    +

    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. + + + + + + + + + + + + + +
    Supported properties
    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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Supported properties
    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
      • +
    +

    at

    +

    The At Adaptor submits jobs to an at scheduler. This adaptor uses either the local or the ssh scheduler adaptor to run commands on the machine running at, 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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Supported properties
    NameDescriptionExpected typeDefault
    xenon.adaptors.schedulers.at.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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Supported properties
    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
      • +
    +

    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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Supported properties
    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
      • +
    +

    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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Supported properties
    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. + + + + + + + +
    Supported properties
    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
      • +
    +

    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. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Supported properties
    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
      • +
    +

    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. + + + + + + + +
    Supported properties
    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
      • +
    +

    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. + + + + + + + +
    Supported properties
    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
      • +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    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.
    +
    +
    +
    +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/jquery/external/jquery/jquery.js b/docs/versions/3.0.1/javadoc/jquery/external/jquery/jquery.js new file mode 100644 index 000000000..9b5206bcc --- /dev/null +++ b/docs/versions/3.0.1/javadoc/jquery/external/jquery/jquery.js @@ -0,0 +1,10364 @@ +/*! + * jQuery JavaScript Library v3.3.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2018-01-20T17:24Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var document = window.document; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var concat = arr.concat; + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + + + + var preservedScriptAttributes = { + type: true, + src: true, + noModule: true + }; + + function DOMEval( code, doc, node ) { + doc = doc || document; + + var i, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + if ( node[ i ] ) { + script[ i ] = node[ i ]; + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.3.1", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }, + + // Support: Android <=4.0 only + // Make sure we trim BOM and NBSP + rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + src = target[ name ]; + copy = options[ name ]; + + // Prevent never-ending loop + if ( target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + + if ( copyIsArray ) { + copyIsArray = false; + clone = src && Array.isArray( src ) ? src : []; + + } else { + clone = src && jQuery.isPlainObject( src ) ? src : {}; + } + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + + /* eslint-disable no-unused-vars */ + // See https://github.com/eslint/eslint/issues/6125 + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a global context + globalEval: function( code ) { + DOMEval( code ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // Support: Android <=4.0 only + trim: function( text ) { + return text == null ? + "" : + ( text + "" ).replace( rtrim, "" ); + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return concat.apply( [], ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.3 + * https://sizzlejs.com/ + * + * Copyright jQuery Foundation and other contributors + * Released under the MIT license + * http://jquery.org/license + * + * Date: 2016-08-08 + */ +(function( window ) { + +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ({}).hasOwnProperty, + arr = [], + pop = arr.pop, + push_native = arr.push, + push = arr.push, + slice = arr.slice, + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[i] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier + identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace + + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ), + + rattributeQuotes = new RegExp( "=" + whitespace + "*([^\\]'\"]*?)" + whitespace + "*\\]", "g" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace + + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace + + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + + whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ), + funescape = function( _, escaped, escapedWhitespace ) { + var high = "0x" + escaped - 0x10000; + // NaN means non-codepoint + // Support: Firefox<24 + // Workaround erroneous numeric interpretation of +"0x" + return high !== high || escapedWhitespace ? + escaped : + high < 0 ? + // BMP codepoint + String.fromCharCode( high + 0x10000 ) : + // Supplemental Plane codepoint (surrogate pair) + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + disabledAncestor = addCombinator( + function( elem ) { + return elem.disabled === true && ("form" in elem || "label" in elem); + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + (arr = slice.call( preferredDoc.childNodes )), + preferredDoc.childNodes + ); + // Support: Android<4.0 + // Detect silently failing push.apply + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + push_native.apply( target, slice.call(els) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + // Can't trust NodeList.length + while ( (target[j++] = els[i++]) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + + if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { + setDocument( context ); + } + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) { + + // ID selector + if ( (m = match[1]) ) { + + // Document context + if ( nodeType === 9 ) { + if ( (elem = context.getElementById( m )) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && (elem = newContext.getElementById( m )) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[2] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( (m = match[3]) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !compilerCache[ selector + " " ] && + (!rbuggyQSA || !rbuggyQSA.test( selector )) ) { + + if ( nodeType !== 1 ) { + newContext = context; + newSelector = selector; + + // qSA looks outside Element context, which is not what we want + // Thanks to Andrew Dupont for this workaround technique + // Support: IE <=8 + // Exclude object elements + } else if ( context.nodeName.toLowerCase() !== "object" ) { + + // Capture the context ID, setting it first if necessary + if ( (nid = context.getAttribute( "id" )) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", (nid = expando) ); + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[i] = "#" + nid + " " + toSelector( groups[i] ); + } + newSelector = groups.join( "," ); + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + } + + if ( newSelector ) { + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return (cache[ key + " " ] = value); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement("fieldset"); + + try { + return !!fn( el ); + } catch (e) { + return false; + } finally { + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split("|"), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[i] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( (cur = cur.nextSibling) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return (name === "input" || name === "button") && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + disabledAncestor( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction(function( argument ) { + argument = +argument; + return markFunction(function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ (j = matchIndexes[i]) ] ) { + seed[j] = !(matches[j] = seed[j]); + } + } + }); + }); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + // documentElement is verified for cases where it doesn't yet exist + // (such as loading iframes in IE - #4833) + var documentElement = elem && (elem.ownerDocument || elem).documentElement; + return documentElement ? documentElement.nodeName !== "HTML" : false; +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9-11, Edge + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + if ( preferredDoc !== document && + (subWindow = document.defaultView) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert(function( el ) { + el.className = "i"; + return !el.getAttribute("className"); + }); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert(function( el ) { + el.appendChild( document.createComment("") ); + return !el.getElementsByTagName("*").length; + }); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert(function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + }); + + // ID filter and find + if ( support.getById ) { + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute("id") === attrId; + }; + }; + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode("id"); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode("id"); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( (elem = elems[i++]) ) { + node = elem.getAttributeNode("id"); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find["TAG"] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( (elem = results[i++]) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( (support.qsa = rnative.test( document.querySelectorAll )) ) { + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert(function( el ) { + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll("[msallowcapture^='']").length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll("[selected]").length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push("~="); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll(":checked").length ) { + rbuggyQSA.push(":checked"); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push(".#.+[+~]"); + } + }); + + assert(function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement("input"); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll("[name=d]").length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll(":enabled").length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll(":disabled").length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll("*,:x"); + rbuggyQSA.push(",.*:"); + }); + } + + if ( (support.matchesSelector = rnative.test( (matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector) )) ) { + + assert(function( el ) { + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + }); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + )); + } : + function( a, b ) { + if ( b ) { + while ( (b = b.parentNode) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) { + + // Choose the first element that is related to our preferred document + if ( a === document || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) { + return -1; + } + if ( b === document || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + return a === document ? -1 : + b === document ? 1 : + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( (cur = cur.parentNode) ) { + ap.unshift( cur ); + } + cur = b; + while ( (cur = cur.parentNode) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[i] === bp[i] ) { + i++; + } + + return i ? + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[i], bp[i] ) : + + // Otherwise nodes in our document sort first + ap[i] === preferredDoc ? -1 : + bp[i] === preferredDoc ? 1 : + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + // Make sure that attribute selectors are quoted + expr = expr.replace( rattributeQuotes, "='$1']" ); + + if ( support.matchesSelector && documentIsHTML && + !compilerCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch (e) {} + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + // Set document vars if needed + if ( ( context.ownerDocument || context ) !== document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + (val = elem.getAttributeNode(name)) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return (sel + "").replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( (elem = results[i++]) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + // If no nodeType, this is expected to be an array + while ( (node = elem[i++]) ) { + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[1] = match[1].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape ); + + if ( match[2] === "~=" ) { + match[3] = " " + match[3] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[1] = match[1].toLowerCase(); + + if ( match[1].slice( 0, 3 ) === "nth" ) { + // nth-* requires argument + if ( !match[3] ) { + Sizzle.error( match[0] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) ); + match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" ); + + // other types prohibit arguments + } else if ( match[3] ) { + Sizzle.error( match[0] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[6] && match[2]; + + if ( matchExpr["CHILD"].test( match[0] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[3] ) { + match[2] = match[4] || match[5] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + // Get excess from tokenize (recursively) + (excess = tokenize( unquoted, true )) && + // advance to the next closing parenthesis + (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) { + + // excess is a negative index + match[0] = match[0].slice( 0, excess ); + match[2] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { return true; } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) && + classCache( className, function( elem ) { + return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== "undefined" && elem.getAttribute("class") || "" ); + }); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + }; + }, + + "CHILD": function( type, what, argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( (node = node[ dir ]) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( (node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + (diff = nodeIndex = 0) || start.pop()) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + // Use previously-cached element index if available + if ( useCache ) { + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + // Use the same loop as above to seek `elem` from the start + while ( (node = ++nodeIndex && node && node[ dir ] || + (diff = nodeIndex = 0) || start.pop()) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || (node[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + (outerCache[ node.uniqueID ] = {}); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction(function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[i] ); + seed[ idx ] = !( matches[ idx ] = matched[i] ); + } + }) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + // Potentially complex pseudos + "not": markFunction(function( selector ) { + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction(function( seed, matches, context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( (elem = unmatched[i]) ) { + seed[i] = !(matches[i] = elem); + } + } + }) : + function( elem, context, xml ) { + input[0] = elem; + matcher( input, null, xml, results ); + // Don't keep the element (issue #299) + input[0] = null; + return !results.pop(); + }; + }), + + "has": markFunction(function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + }), + + "contains": markFunction(function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || elem.innerText || getText( elem ) ).indexOf( text ) > -1; + }; + }), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + // lang value must be a valid identifier + if ( !ridentifier.test(lang || "") ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( (elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( (elem = elem.parentNode) && elem.nodeType === 1 ); + return false; + }; + }), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected); + }, + + "selected": function( elem ) { + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos["empty"]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo(function() { + return [ 0 ]; + }), + + "last": createPositionalPseudo(function( matchIndexes, length ) { + return [ length - 1 ]; + }), + + "eq": createPositionalPseudo(function( matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + }), + + "even": createPositionalPseudo(function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "odd": createPositionalPseudo(function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "lt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "gt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }) + } +}; + +Expr.pseudos["nth"] = Expr.pseudos["eq"]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || (match = rcomma.exec( soFar )) ) { + if ( match ) { + // Don't consume trailing commas as valid + soFar = soFar.slice( match[0].length ) || soFar; + } + groups.push( (tokens = []) ); + } + + matched = false; + + // Combinators + if ( (match = rcombinators.exec( soFar )) ) { + matched = match.shift(); + tokens.push({ + value: matched, + // Cast descendant combinators to space + type: match[0].replace( rtrim, " " ) + }); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] || + (match = preFilters[ type ]( match ))) ) { + matched = match.shift(); + tokens.push({ + value: matched, + type: type, + matches: match + }); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[i].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || (elem[ expando ] = {}); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || (outerCache[ elem.uniqueID ] = {}); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( (oldCache = uniqueCache[ key ]) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return (newCache[ 2 ] = oldCache[ 2 ]); + } else { + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[i]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[0]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[i], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( (elem = unmatched[i]) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction(function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( (elem = temp[i]) ) { + matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) ) { + // Restore matcherIn since elem is not yet a final match + temp.push( (matcherIn[i] = elem) ); + } + } + postFinder( null, (matcherOut = []), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) && + (temp = postFinder ? indexOf( seed, elem ) : preMap[i]) > -1 ) { + + seed[temp] = !(results[temp] = elem); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + }); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[0].type ], + implicitRelative = leadingRelative || Expr.relative[" "], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + (checkContext = context).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( (matcher = Expr.relative[ tokens[i].type ]) ) { + matchers = [ addCombinator(elementMatcher( matchers ), matcher) ]; + } else { + matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[j].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" }) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( (tokens = tokens.slice( j )) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find["TAG"]( "*", outermost ), + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1), + len = elems.length; + + if ( outermost ) { + outermostContext = context === document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && (elem = elems[i]) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + if ( !context && elem.ownerDocument !== document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( (matcher = elementMatchers[j++]) ) { + if ( matcher( elem, context || document, xml) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + // They will have gone through all possible matchers + if ( (elem = !matcher && elem) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( (matcher = setMatchers[j++]) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !(unmatched[i] || setMatched[i]) ) { + setMatched[i] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[i] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( (selector = compiled.selector || selector) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[0] = match[0].slice( 0 ); + if ( tokens.length > 2 && (token = tokens[0]).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[1].type ] ) { + + context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[i]; + + // Abort if we hit a combinator + if ( Expr.relative[ (type = token.type) ] ) { + break; + } + if ( (find = Expr.find[ type ]) ) { + // Search, expanding context for leading sibling combinators + if ( (seed = find( + token.matches[0].replace( runescape, funescape ), + rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context + )) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split("").sort( sortOrder ).join("") === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert(function( el ) { + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement("fieldset") ) & 1; +}); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert(function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute("href") === "#" ; +}) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + }); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert(function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +}) ) { + addHandle( "value", function( elem, name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + }); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert(function( el ) { + return el.getAttribute("disabled") == null; +}) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + (val = elem.getAttributeNode( name )) && val.specified ? + val.value : + null; + } + }); +} + +return Sizzle; + +})( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( nodeName( elem, "iframe" ) ) { + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the master Deferred + master = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + master.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( master.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return master.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); + } + + return master.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; + }, + access: function( owner, key, value ) { + + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ( ( key && typeof key === "string" ) && value === undefined ) ) { + + return this.get( owner, key ); + } + + // When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// Implementation Summary +// +// 1. Enforce API surface and semantic compatibility with 1.9.x branch +// 2. Improve the module's maintainability by reducing the storage +// paths to a single mechanism. +// 3. Use the same single mechanism to support "private" and "user" data. +// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) +// 5. Avoid exposing implementation details on user objects (eg. expando properties) +// 6. Provide a clear path for implementation upgrade to WeakMap in 2014 + +var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + + // Attempt to get data from the cache + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.access( elem, type, jQuery.makeArray( data ) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // Clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // Not public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.remove( elem, [ type + "queue", key ] ); + } ) + } ); + } +} ); + +jQuery.fn.extend( { + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[ 0 ], type ); + } + + return data === undefined ? + this : + this.each( function() { + var queue = jQuery.queue( this, type, data ); + + // Ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[ 0 ] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + } ); + }, + dequeue: function( type ) { + return this.each( function() { + jQuery.dequeue( this, type ); + } ); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while ( i-- ) { + tmp = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + jQuery.contains( elem.ownerDocument, elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + +var swap = function( elem, options, callback, args ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.apply( elem, args || [] ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]+)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // Support: IE <=9 only + option: [ 1, "" ], + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
    " ], + col: [ 2, "", "
    " ], + tr: [ 2, "", "
    " ], + td: [ 3, "", "
    " ], + + _default: [ 0, "", "" ] +}; + +// Support: IE <=9 only +wrapMap.optgroup = wrapMap.option; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, contains, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + contains = jQuery.contains( elem.ownerDocument, elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( contains ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; +} )(); +var documentElement = document.documentElement; + + + +var + rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 only +// See #13393 for more info +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + if ( data == null && fn == null ) { + + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return elem; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.get( elem ); + + // Don't attach events to noData or text/comment nodes (but allow plain objects) + if ( !elemData ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = {}; + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + // Make a writable jQuery.Event from the native event object + var event = jQuery.event.fix( nativeEvent ); + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + handlers = ( dataPriv.get( this, "events" ) || {} )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // Triggered event must either 1) have no namespace, or 2) have namespace(s) + // a subset or equal to those in the bound event (both can have no namespace). + if ( !event.rnamespace || event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + focus: { + + // Fire native event if possible so blur/focus sequence is correct + trigger: function() { + if ( this !== safeActiveElement() && this.focus ) { + this.focus(); + return false; + } + }, + delegateType: "focusin" + }, + blur: { + trigger: function() { + if ( this === safeActiveElement() && this.blur ) { + this.blur(); + return false; + } + }, + delegateType: "focusout" + }, + click: { + + // For checkbox, fire native event so checked state will be right + trigger: function() { + if ( this.type === "checkbox" && this.click && nodeName( this, "input" ) ) { + this.click(); + return false; + } + }, + + // For cross-browser consistency, don't fire native .click() on links + _default: function( event ) { + return nodeName( event.target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +jQuery.Event = function( src, props ) { + + // Allow instantiation without the 'new' keyword + if ( !( this instanceof jQuery.Event ) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = src.defaultPrevented || + src.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + + which: function( event ) { + var button = event.button; + + // Add which for key events + if ( event.which == null && rkeyEvent.test( event.type ) ) { + return event.charCode != null ? event.charCode : event.keyCode; + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { + if ( button & 1 ) { + return 1; + } + + if ( button & 2 ) { + return 3; + } + + if ( button & 4 ) { + return 2; + } + + return 0; + } + + return event.which; + } +}, jQuery.event.addProp ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mouseenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? + handleObj.origType + "." + handleObj.namespace : + handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each( function() { + jQuery.event.remove( this, types, fn, selector ); + } ); + } +} ); + + +var + + /* eslint-disable max-len */ + + // See https://github.com/eslint/eslint/issues/3229 + rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi, + + /* eslint-enable */ + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, pdataCur, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.access( src ); + pdataCur = dataPriv.set( dest, pdataOld ); + events = pdataOld.events; + + if ( events ) { + delete pdataCur.handle; + pdataCur.events = {}; + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = concat.apply( [], args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl ) { + jQuery._evalUrl( node.src ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), doc, node ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && jQuery.contains( node.ownerDocument, node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html.replace( rxhtmlTag, "<$1>" ); + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = jQuery.contains( elem.ownerDocument, elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + div.style.position = "absolute"; + scrollboxSizeVal = div.offsetWidth === 36 || "absolute"; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !jQuery.contains( elem.ownerDocument, elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }, + + cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style; + +// Return a css property mapped to a potentially vendor prefixed property +function vendorPropName( name ) { + + // Shortcut for names that are not vendor prefixed + if ( name in emptyStyle ) { + return name; + } + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a property mapped along what jQuery.cssProps suggests or to +// a vendor prefixed property. +function finalPropName( name ) { + var ret = jQuery.cssProps[ name ]; + if ( !ret ) { + ret = jQuery.cssProps[ name ] = vendorPropName( name ) || name; + } + return ret; +} + +function setPositiveNumber( elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + ) ); + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + val = curCSS( elem, dimension, styles ), + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox; + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + // Check for style in case a browser which returns unreliable values + // for getComputedStyle silently falls back to the reliable elem.style + valueIsBorderBox = valueIsBorderBox && + ( support.boxSizingReliable() || val === elem.style[ dimension ] ); + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + if ( val === "auto" || + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) { + + val = elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ]; + + // offsetWidth/offsetHeight provide border-box values + valueIsBorderBox = true; + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + if ( type === "number" ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra && boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ); + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && support.scrollboxSize() === styles.position ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && + ( tween.elem.style[ jQuery.cssProps[ tween.prop ] ] != null || + jQuery.cssHooks[ tween.prop ] ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue && type !== false ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( dataPriv.get( cur, "events" ) || {} )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + var doc = this.ownerDocument || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = Date.now(); + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ) + .filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ) + .map( function( i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() ] = match[ 2 ]; + } + } + match = responseHeaders[ key.toLowerCase() ]; + } + return match == null ? null : match; + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce++ ) + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + + +jQuery._evalUrl = function( url ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + "throws": true + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain requests + if ( s.crossDomain ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( "\r\n"; + +// inject VBScript +document.write(IEBinaryToArray_ByteStr_Script); + +global.JSZipUtils._getBinaryFromXHR = function (xhr) { + var binary = xhr.responseBody; + var byteMapping = {}; + for ( var i = 0; i < 256; i++ ) { + for ( var j = 0; j < 256; j++ ) { + byteMapping[ String.fromCharCode( i + (j << 8) ) ] = + String.fromCharCode(i) + String.fromCharCode(j); + } + } + var rawBytes = IEBinaryToArray_ByteStr(binary); + var lastChr = IEBinaryToArray_ByteStr_Last(binary); + return rawBytes.replace(/[\s\S]/g, function( match ) { + return byteMapping[match]; + }) + lastChr; +}; + +// enforcing Stuk's coding style +// vim: set shiftwidth=4 softtabstop=4: + +},{}]},{},[1]) +; diff --git a/docs/versions/3.0.1/javadoc/jquery/jszip-utils/dist/jszip-utils-ie.min.js b/docs/versions/3.0.1/javadoc/jquery/jszip-utils/dist/jszip-utils-ie.min.js new file mode 100644 index 000000000..93d8bc8ef --- /dev/null +++ b/docs/versions/3.0.1/javadoc/jquery/jszip-utils/dist/jszip-utils-ie.min.js @@ -0,0 +1,10 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g\r\n";document.write(b),a.JSZipUtils._getBinaryFromXHR=function(a){for(var b=a.responseBody,c={},d=0;256>d;d++)for(var e=0;256>e;e++)c[String.fromCharCode(d+(e<<8))]=String.fromCharCode(d)+String.fromCharCode(e);var f=IEBinaryToArray_ByteStr(b),g=IEBinaryToArray_ByteStr_Last(b);return f.replace(/[\s\S]/g,function(a){return c[a]})+g}},{}]},{},[1]); diff --git a/docs/versions/3.0.1/javadoc/jquery/jszip-utils/dist/jszip-utils.js b/docs/versions/3.0.1/javadoc/jquery/jszip-utils/dist/jszip-utils.js new file mode 100644 index 000000000..775895ec9 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/jquery/jszip-utils/dist/jszip-utils.js @@ -0,0 +1,118 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(e){"object"==typeof exports?module.exports=e():"function"==typeof define&&define.amd?define(e):"undefined"!=typeof window?window.JSZipUtils=e():"undefined"!=typeof global?global.JSZipUtils=e():"undefined"!=typeof self&&(self.JSZipUtils=e())}(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(a){"object"==typeof exports?module.exports=a():"function"==typeof define&&define.amd?define(a):"undefined"!=typeof window?window.JSZipUtils=a():"undefined"!=typeof global?global.JSZipUtils=a():"undefined"!=typeof self&&(self.JSZipUtils=a())}(function(){return function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g + +(c) 2009-2016 Stuart Knightley +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip/master/LICENSE.markdown. + +JSZip uses the library pako released under the MIT license : +https://github.com/nodeca/pako/blob/master/LICENSE +*/ + +(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.JSZip = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o> 2; + enc2 = ((chr1 & 3) << 4) | (chr2 >> 4); + enc3 = remainingBytes > 1 ? (((chr2 & 15) << 2) | (chr3 >> 6)) : 64; + enc4 = remainingBytes > 2 ? (chr3 & 63) : 64; + + output.push(_keyStr.charAt(enc1) + _keyStr.charAt(enc2) + _keyStr.charAt(enc3) + _keyStr.charAt(enc4)); + + } + + return output.join(""); +}; + +// public method for decoding +exports.decode = function(input) { + var chr1, chr2, chr3; + var enc1, enc2, enc3, enc4; + var i = 0, resultIndex = 0; + + var dataUrlPrefix = "data:"; + + if (input.substr(0, dataUrlPrefix.length) === dataUrlPrefix) { + // This is a common error: people give a data url + // (data:image/png;base64,iVBOR...) with a {base64: true} and + // wonders why things don't work. + // We can detect that the string input looks like a data url but we + // *can't* be sure it is one: removing everything up to the comma would + // be too dangerous. + throw new Error("Invalid base64 input, it looks like a data url."); + } + + input = input.replace(/[^A-Za-z0-9\+\/\=]/g, ""); + + var totalLength = input.length * 3 / 4; + if(input.charAt(input.length - 1) === _keyStr.charAt(64)) { + totalLength--; + } + if(input.charAt(input.length - 2) === _keyStr.charAt(64)) { + totalLength--; + } + if (totalLength % 1 !== 0) { + // totalLength is not an integer, the length does not match a valid + // base64 content. That can happen if: + // - the input is not a base64 content + // - the input is *almost* a base64 content, with a extra chars at the + // beginning or at the end + // - the input uses a base64 variant (base64url for example) + throw new Error("Invalid base64 input, bad content length."); + } + var output; + if (support.uint8array) { + output = new Uint8Array(totalLength|0); + } else { + output = new Array(totalLength|0); + } + + while (i < input.length) { + + enc1 = _keyStr.indexOf(input.charAt(i++)); + enc2 = _keyStr.indexOf(input.charAt(i++)); + enc3 = _keyStr.indexOf(input.charAt(i++)); + enc4 = _keyStr.indexOf(input.charAt(i++)); + + chr1 = (enc1 << 2) | (enc2 >> 4); + chr2 = ((enc2 & 15) << 4) | (enc3 >> 2); + chr3 = ((enc3 & 3) << 6) | enc4; + + output[resultIndex++] = chr1; + + if (enc3 !== 64) { + output[resultIndex++] = chr2; + } + if (enc4 !== 64) { + output[resultIndex++] = chr3; + } + + } + + return output; +}; + +},{"./support":30,"./utils":32}],2:[function(require,module,exports){ +'use strict'; + +var external = require("./external"); +var DataWorker = require('./stream/DataWorker'); +var DataLengthProbe = require('./stream/DataLengthProbe'); +var Crc32Probe = require('./stream/Crc32Probe'); +var DataLengthProbe = require('./stream/DataLengthProbe'); + +/** + * Represent a compressed object, with everything needed to decompress it. + * @constructor + * @param {number} compressedSize the size of the data compressed. + * @param {number} uncompressedSize the size of the data after decompression. + * @param {number} crc32 the crc32 of the decompressed file. + * @param {object} compression the type of compression, see lib/compressions.js. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the compressed data. + */ +function CompressedObject(compressedSize, uncompressedSize, crc32, compression, data) { + this.compressedSize = compressedSize; + this.uncompressedSize = uncompressedSize; + this.crc32 = crc32; + this.compression = compression; + this.compressedContent = data; +} + +CompressedObject.prototype = { + /** + * Create a worker to get the uncompressed content. + * @return {GenericWorker} the worker. + */ + getContentWorker : function () { + var worker = new DataWorker(external.Promise.resolve(this.compressedContent)) + .pipe(this.compression.uncompressWorker()) + .pipe(new DataLengthProbe("data_length")); + + var that = this; + worker.on("end", function () { + if(this.streamInfo['data_length'] !== that.uncompressedSize) { + throw new Error("Bug : uncompressed data size mismatch"); + } + }); + return worker; + }, + /** + * Create a worker to get the compressed content. + * @return {GenericWorker} the worker. + */ + getCompressedWorker : function () { + return new DataWorker(external.Promise.resolve(this.compressedContent)) + .withStreamInfo("compressedSize", this.compressedSize) + .withStreamInfo("uncompressedSize", this.uncompressedSize) + .withStreamInfo("crc32", this.crc32) + .withStreamInfo("compression", this.compression) + ; + } +}; + +/** + * Chain the given worker with other workers to compress the content with the + * given compresion. + * @param {GenericWorker} uncompressedWorker the worker to pipe. + * @param {Object} compression the compression object. + * @param {Object} compressionOptions the options to use when compressing. + * @return {GenericWorker} the new worker compressing the content. + */ +CompressedObject.createWorkerFrom = function (uncompressedWorker, compression, compressionOptions) { + return uncompressedWorker + .pipe(new Crc32Probe()) + .pipe(new DataLengthProbe("uncompressedSize")) + .pipe(compression.compressWorker(compressionOptions)) + .pipe(new DataLengthProbe("compressedSize")) + .withStreamInfo("compression", compression); +}; + +module.exports = CompressedObject; + +},{"./external":6,"./stream/Crc32Probe":25,"./stream/DataLengthProbe":26,"./stream/DataWorker":27}],3:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require("./stream/GenericWorker"); + +exports.STORE = { + magic: "\x00\x00", + compressWorker : function (compressionOptions) { + return new GenericWorker("STORE compression"); + }, + uncompressWorker : function () { + return new GenericWorker("STORE decompression"); + } +}; +exports.DEFLATE = require('./flate'); + +},{"./flate":7,"./stream/GenericWorker":28}],4:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); + +/** + * The following functions come from pako, from pako/lib/zlib/crc32.js + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Use ordinary array, since untyped makes no boost here +function makeTable() { + var c, table = []; + + for(var n =0; n < 256; n++){ + c = n; + for(var k =0; k < 8; k++){ + c = ((c&1) ? (0xEDB88320 ^ (c >>> 1)) : (c >>> 1)); + } + table[n] = c; + } + + return table; +} + +// Create table on load. Just 255 signed longs. Not a problem. +var crcTable = makeTable(); + + +function crc32(crc, buf, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ buf[i]) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +// That's all for the pako functions. + +/** + * Compute the crc32 of a string. + * This is almost the same as the function crc32, but for strings. Using the + * same function for the two use cases leads to horrible performances. + * @param {Number} crc the starting value of the crc. + * @param {String} str the string to use. + * @param {Number} len the length of the string. + * @param {Number} pos the starting position for the crc32 computation. + * @return {Number} the computed crc32. + */ +function crc32str(crc, str, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ str.charCodeAt(i)) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +module.exports = function crc32wrapper(input, crc) { + if (typeof input === "undefined" || !input.length) { + return 0; + } + + var isArray = utils.getTypeOf(input) !== "string"; + + if(isArray) { + return crc32(crc|0, input, input.length, 0); + } else { + return crc32str(crc|0, input, input.length, 0); + } +}; + +},{"./utils":32}],5:[function(require,module,exports){ +'use strict'; +exports.base64 = false; +exports.binary = false; +exports.dir = false; +exports.createFolders = true; +exports.date = null; +exports.compression = null; +exports.compressionOptions = null; +exports.comment = null; +exports.unixPermissions = null; +exports.dosPermissions = null; + +},{}],6:[function(require,module,exports){ +/* global Promise */ +'use strict'; + +// load the global object first: +// - it should be better integrated in the system (unhandledRejection in node) +// - the environment may have a custom Promise implementation (see zone.js) +var ES6Promise = null; +if (typeof Promise !== "undefined") { + ES6Promise = Promise; +} else { + ES6Promise = require("lie"); +} + +/** + * Let the user use/change some implementations. + */ +module.exports = { + Promise: ES6Promise +}; + +},{"lie":58}],7:[function(require,module,exports){ +'use strict'; +var USE_TYPEDARRAY = (typeof Uint8Array !== 'undefined') && (typeof Uint16Array !== 'undefined') && (typeof Uint32Array !== 'undefined'); + +var pako = require("pako"); +var utils = require("./utils"); +var GenericWorker = require("./stream/GenericWorker"); + +var ARRAY_TYPE = USE_TYPEDARRAY ? "uint8array" : "array"; + +exports.magic = "\x08\x00"; + +/** + * Create a worker that uses pako to inflate/deflate. + * @constructor + * @param {String} action the name of the pako function to call : either "Deflate" or "Inflate". + * @param {Object} options the options to use when (de)compressing. + */ +function FlateWorker(action, options) { + GenericWorker.call(this, "FlateWorker/" + action); + + this._pako = null; + this._pakoAction = action; + this._pakoOptions = options; + // the `meta` object from the last chunk received + // this allow this worker to pass around metadata + this.meta = {}; +} + +utils.inherits(FlateWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +FlateWorker.prototype.processChunk = function (chunk) { + this.meta = chunk.meta; + if (this._pako === null) { + this._createPako(); + } + this._pako.push(utils.transformTo(ARRAY_TYPE, chunk.data), false); +}; + +/** + * @see GenericWorker.flush + */ +FlateWorker.prototype.flush = function () { + GenericWorker.prototype.flush.call(this); + if (this._pako === null) { + this._createPako(); + } + this._pako.push([], true); +}; +/** + * @see GenericWorker.cleanUp + */ +FlateWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this._pako = null; +}; + +/** + * Create the _pako object. + * TODO: lazy-loading this object isn't the best solution but it's the + * quickest. The best solution is to lazy-load the worker list. See also the + * issue #446. + */ +FlateWorker.prototype._createPako = function () { + this._pako = new pako[this._pakoAction]({ + raw: true, + level: this._pakoOptions.level || -1 // default compression + }); + var self = this; + this._pako.onData = function(data) { + self.push({ + data : data, + meta : self.meta + }); + }; +}; + +exports.compressWorker = function (compressionOptions) { + return new FlateWorker("Deflate", compressionOptions); +}; +exports.uncompressWorker = function () { + return new FlateWorker("Inflate", {}); +}; + +},{"./stream/GenericWorker":28,"./utils":32,"pako":59}],8:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); +var utf8 = require('../utf8'); +var crc32 = require('../crc32'); +var signature = require('../signature'); + +/** + * Transform an integer into a string in hexadecimal. + * @private + * @param {number} dec the number to convert. + * @param {number} bytes the number of bytes to generate. + * @returns {string} the result. + */ +var decToHex = function(dec, bytes) { + var hex = "", i; + for (i = 0; i < bytes; i++) { + hex += String.fromCharCode(dec & 0xff); + dec = dec >>> 8; + } + return hex; +}; + +/** + * Generate the UNIX part of the external file attributes. + * @param {Object} unixPermissions the unix permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * adapted from http://unix.stackexchange.com/questions/14705/the-zip-formats-external-file-attribute : + * + * TTTTsstrwxrwxrwx0000000000ADVSHR + * ^^^^____________________________ file type, see zipinfo.c (UNX_*) + * ^^^_________________________ setuid, setgid, sticky + * ^^^^^^^^^________________ permissions + * ^^^^^^^^^^______ not used ? + * ^^^^^^ DOS attribute bits : Archive, Directory, Volume label, System file, Hidden, Read only + */ +var generateUnixExternalFileAttr = function (unixPermissions, isDir) { + + var result = unixPermissions; + if (!unixPermissions) { + // I can't use octal values in strict mode, hence the hexa. + // 040775 => 0x41fd + // 0100664 => 0x81b4 + result = isDir ? 0x41fd : 0x81b4; + } + return (result & 0xFFFF) << 16; +}; + +/** + * Generate the DOS part of the external file attributes. + * @param {Object} dosPermissions the dos permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * Bit 0 Read-Only + * Bit 1 Hidden + * Bit 2 System + * Bit 3 Volume Label + * Bit 4 Directory + * Bit 5 Archive + */ +var generateDosExternalFileAttr = function (dosPermissions, isDir) { + + // the dir flag is already set for compatibility + return (dosPermissions || 0) & 0x3F; +}; + +/** + * Generate the various parts used in the construction of the final zip file. + * @param {Object} streamInfo the hash with informations about the compressed file. + * @param {Boolean} streamedContent is the content streamed ? + * @param {Boolean} streamingEnded is the stream finished ? + * @param {number} offset the current offset from the start of the zip file. + * @param {String} platform let's pretend we are this platform (change platform dependents fields) + * @param {Function} encodeFileName the function to encode the file name / comment. + * @return {Object} the zip parts. + */ +var generateZipParts = function(streamInfo, streamedContent, streamingEnded, offset, platform, encodeFileName) { + var file = streamInfo['file'], + compression = streamInfo['compression'], + useCustomEncoding = encodeFileName !== utf8.utf8encode, + encodedFileName = utils.transformTo("string", encodeFileName(file.name)), + utfEncodedFileName = utils.transformTo("string", utf8.utf8encode(file.name)), + comment = file.comment, + encodedComment = utils.transformTo("string", encodeFileName(comment)), + utfEncodedComment = utils.transformTo("string", utf8.utf8encode(comment)), + useUTF8ForFileName = utfEncodedFileName.length !== file.name.length, + useUTF8ForComment = utfEncodedComment.length !== comment.length, + dosTime, + dosDate, + extraFields = "", + unicodePathExtraField = "", + unicodeCommentExtraField = "", + dir = file.dir, + date = file.date; + + + var dataInfo = { + crc32 : 0, + compressedSize : 0, + uncompressedSize : 0 + }; + + // if the content is streamed, the sizes/crc32 are only available AFTER + // the end of the stream. + if (!streamedContent || streamingEnded) { + dataInfo.crc32 = streamInfo['crc32']; + dataInfo.compressedSize = streamInfo['compressedSize']; + dataInfo.uncompressedSize = streamInfo['uncompressedSize']; + } + + var bitflag = 0; + if (streamedContent) { + // Bit 3: the sizes/crc32 are set to zero in the local header. + // The correct values are put in the data descriptor immediately + // following the compressed data. + bitflag |= 0x0008; + } + if (!useCustomEncoding && (useUTF8ForFileName || useUTF8ForComment)) { + // Bit 11: Language encoding flag (EFS). + bitflag |= 0x0800; + } + + + var extFileAttr = 0; + var versionMadeBy = 0; + if (dir) { + // dos or unix, we set the dos dir flag + extFileAttr |= 0x00010; + } + if(platform === "UNIX") { + versionMadeBy = 0x031E; // UNIX, version 3.0 + extFileAttr |= generateUnixExternalFileAttr(file.unixPermissions, dir); + } else { // DOS or other, fallback to DOS + versionMadeBy = 0x0014; // DOS, version 2.0 + extFileAttr |= generateDosExternalFileAttr(file.dosPermissions, dir); + } + + // date + // @see http://www.delorie.com/djgpp/doc/rbinter/it/52/13.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/65/16.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/66/16.html + + dosTime = date.getUTCHours(); + dosTime = dosTime << 6; + dosTime = dosTime | date.getUTCMinutes(); + dosTime = dosTime << 5; + dosTime = dosTime | date.getUTCSeconds() / 2; + + dosDate = date.getUTCFullYear() - 1980; + dosDate = dosDate << 4; + dosDate = dosDate | (date.getUTCMonth() + 1); + dosDate = dosDate << 5; + dosDate = dosDate | date.getUTCDate(); + + if (useUTF8ForFileName) { + // set the unicode path extra field. unzip needs at least one extra + // field to correctly handle unicode path, so using the path is as good + // as any other information. This could improve the situation with + // other archive managers too. + // This field is usually used without the utf8 flag, with a non + // unicode path in the header (winrar, winzip). This helps (a bit) + // with the messy Windows' default compressed folders feature but + // breaks on p7zip which doesn't seek the unicode path extra field. + // So for now, UTF-8 everywhere ! + unicodePathExtraField = + // Version + decToHex(1, 1) + + // NameCRC32 + decToHex(crc32(encodedFileName), 4) + + // UnicodeName + utfEncodedFileName; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x70" + + // size + decToHex(unicodePathExtraField.length, 2) + + // content + unicodePathExtraField; + } + + if(useUTF8ForComment) { + + unicodeCommentExtraField = + // Version + decToHex(1, 1) + + // CommentCRC32 + decToHex(crc32(encodedComment), 4) + + // UnicodeName + utfEncodedComment; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x63" + + // size + decToHex(unicodeCommentExtraField.length, 2) + + // content + unicodeCommentExtraField; + } + + var header = ""; + + // version needed to extract + header += "\x0A\x00"; + // general purpose bit flag + header += decToHex(bitflag, 2); + // compression method + header += compression.magic; + // last mod file time + header += decToHex(dosTime, 2); + // last mod file date + header += decToHex(dosDate, 2); + // crc-32 + header += decToHex(dataInfo.crc32, 4); + // compressed size + header += decToHex(dataInfo.compressedSize, 4); + // uncompressed size + header += decToHex(dataInfo.uncompressedSize, 4); + // file name length + header += decToHex(encodedFileName.length, 2); + // extra field length + header += decToHex(extraFields.length, 2); + + + var fileRecord = signature.LOCAL_FILE_HEADER + header + encodedFileName + extraFields; + + var dirRecord = signature.CENTRAL_FILE_HEADER + + // version made by (00: DOS) + decToHex(versionMadeBy, 2) + + // file header (common to file and central directory) + header + + // file comment length + decToHex(encodedComment.length, 2) + + // disk number start + "\x00\x00" + + // internal file attributes TODO + "\x00\x00" + + // external file attributes + decToHex(extFileAttr, 4) + + // relative offset of local header + decToHex(offset, 4) + + // file name + encodedFileName + + // extra field + extraFields + + // file comment + encodedComment; + + return { + fileRecord: fileRecord, + dirRecord: dirRecord + }; +}; + +/** + * Generate the EOCD record. + * @param {Number} entriesCount the number of entries in the zip file. + * @param {Number} centralDirLength the length (in bytes) of the central dir. + * @param {Number} localDirLength the length (in bytes) of the local dir. + * @param {String} comment the zip file comment as a binary string. + * @param {Function} encodeFileName the function to encode the comment. + * @return {String} the EOCD record. + */ +var generateCentralDirectoryEnd = function (entriesCount, centralDirLength, localDirLength, comment, encodeFileName) { + var dirEnd = ""; + var encodedComment = utils.transformTo("string", encodeFileName(comment)); + + // end of central dir signature + dirEnd = signature.CENTRAL_DIRECTORY_END + + // number of this disk + "\x00\x00" + + // number of the disk with the start of the central directory + "\x00\x00" + + // total number of entries in the central directory on this disk + decToHex(entriesCount, 2) + + // total number of entries in the central directory + decToHex(entriesCount, 2) + + // size of the central directory 4 bytes + decToHex(centralDirLength, 4) + + // offset of start of central directory with respect to the starting disk number + decToHex(localDirLength, 4) + + // .ZIP file comment length + decToHex(encodedComment.length, 2) + + // .ZIP file comment + encodedComment; + + return dirEnd; +}; + +/** + * Generate data descriptors for a file entry. + * @param {Object} streamInfo the hash generated by a worker, containing informations + * on the file entry. + * @return {String} the data descriptors. + */ +var generateDataDescriptors = function (streamInfo) { + var descriptor = ""; + descriptor = signature.DATA_DESCRIPTOR + + // crc-32 4 bytes + decToHex(streamInfo['crc32'], 4) + + // compressed size 4 bytes + decToHex(streamInfo['compressedSize'], 4) + + // uncompressed size 4 bytes + decToHex(streamInfo['uncompressedSize'], 4); + + return descriptor; +}; + + +/** + * A worker to concatenate other workers to create a zip file. + * @param {Boolean} streamFiles `true` to stream the content of the files, + * `false` to accumulate it. + * @param {String} comment the comment to use. + * @param {String} platform the platform to use, "UNIX" or "DOS". + * @param {Function} encodeFileName the function to encode file names and comments. + */ +function ZipFileWorker(streamFiles, comment, platform, encodeFileName) { + GenericWorker.call(this, "ZipFileWorker"); + // The number of bytes written so far. This doesn't count accumulated chunks. + this.bytesWritten = 0; + // The comment of the zip file + this.zipComment = comment; + // The platform "generating" the zip file. + this.zipPlatform = platform; + // the function to encode file names and comments. + this.encodeFileName = encodeFileName; + // Should we stream the content of the files ? + this.streamFiles = streamFiles; + // If `streamFiles` is false, we will need to accumulate the content of the + // files to calculate sizes / crc32 (and write them *before* the content). + // This boolean indicates if we are accumulating chunks (it will change a lot + // during the lifetime of this worker). + this.accumulate = false; + // The buffer receiving chunks when accumulating content. + this.contentBuffer = []; + // The list of generated directory records. + this.dirRecords = []; + // The offset (in bytes) from the beginning of the zip file for the current source. + this.currentSourceOffset = 0; + // The total number of entries in this zip file. + this.entriesCount = 0; + // the name of the file currently being added, null when handling the end of the zip file. + // Used for the emited metadata. + this.currentFile = null; + + + + this._sources = []; +} +utils.inherits(ZipFileWorker, GenericWorker); + +/** + * @see GenericWorker.push + */ +ZipFileWorker.prototype.push = function (chunk) { + + var currentFilePercent = chunk.meta.percent || 0; + var entriesCount = this.entriesCount; + var remainingFiles = this._sources.length; + + if(this.accumulate) { + this.contentBuffer.push(chunk); + } else { + this.bytesWritten += chunk.data.length; + + GenericWorker.prototype.push.call(this, { + data : chunk.data, + meta : { + currentFile : this.currentFile, + percent : entriesCount ? (currentFilePercent + 100 * (entriesCount - remainingFiles - 1)) / entriesCount : 100 + } + }); + } +}; + +/** + * The worker started a new source (an other worker). + * @param {Object} streamInfo the streamInfo object from the new source. + */ +ZipFileWorker.prototype.openedSource = function (streamInfo) { + this.currentSourceOffset = this.bytesWritten; + this.currentFile = streamInfo['file'].name; + + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + + // don't stream folders (because they don't have any content) + if(streamedContent) { + var record = generateZipParts(streamInfo, streamedContent, false, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + } else { + // we need to wait for the whole file before pushing anything + this.accumulate = true; + } +}; + +/** + * The worker finished a source (an other worker). + * @param {Object} streamInfo the streamInfo object from the finished source. + */ +ZipFileWorker.prototype.closedSource = function (streamInfo) { + this.accumulate = false; + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + var record = generateZipParts(streamInfo, streamedContent, true, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + + this.dirRecords.push(record.dirRecord); + if(streamedContent) { + // after the streamed file, we put data descriptors + this.push({ + data : generateDataDescriptors(streamInfo), + meta : {percent:100} + }); + } else { + // the content wasn't streamed, we need to push everything now + // first the file record, then the content + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + while(this.contentBuffer.length) { + this.push(this.contentBuffer.shift()); + } + } + this.currentFile = null; +}; + +/** + * @see GenericWorker.flush + */ +ZipFileWorker.prototype.flush = function () { + + var localDirLength = this.bytesWritten; + for(var i = 0; i < this.dirRecords.length; i++) { + this.push({ + data : this.dirRecords[i], + meta : {percent:100} + }); + } + var centralDirLength = this.bytesWritten - localDirLength; + + var dirEnd = generateCentralDirectoryEnd(this.dirRecords.length, centralDirLength, localDirLength, this.zipComment, this.encodeFileName); + + this.push({ + data : dirEnd, + meta : {percent:100} + }); +}; + +/** + * Prepare the next source to be read. + */ +ZipFileWorker.prototype.prepareNextSource = function () { + this.previous = this._sources.shift(); + this.openedSource(this.previous.streamInfo); + if (this.isPaused) { + this.previous.pause(); + } else { + this.previous.resume(); + } +}; + +/** + * @see GenericWorker.registerPrevious + */ +ZipFileWorker.prototype.registerPrevious = function (previous) { + this._sources.push(previous); + var self = this; + + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.closedSource(self.previous.streamInfo); + if(self._sources.length) { + self.prepareNextSource(); + } else { + self.end(); + } + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; +}; + +/** + * @see GenericWorker.resume + */ +ZipFileWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this.previous && this._sources.length) { + this.prepareNextSource(); + return true; + } + if (!this.previous && !this._sources.length && !this.generatedError) { + this.end(); + return true; + } +}; + +/** + * @see GenericWorker.error + */ +ZipFileWorker.prototype.error = function (e) { + var sources = this._sources; + if(!GenericWorker.prototype.error.call(this, e)) { + return false; + } + for(var i = 0; i < sources.length; i++) { + try { + sources[i].error(e); + } catch(e) { + // the `error` exploded, nothing to do + } + } + return true; +}; + +/** + * @see GenericWorker.lock + */ +ZipFileWorker.prototype.lock = function () { + GenericWorker.prototype.lock.call(this); + var sources = this._sources; + for(var i = 0; i < sources.length; i++) { + sources[i].lock(); + } +}; + +module.exports = ZipFileWorker; + +},{"../crc32":4,"../signature":23,"../stream/GenericWorker":28,"../utf8":31,"../utils":32}],9:[function(require,module,exports){ +'use strict'; + +var compressions = require('../compressions'); +var ZipFileWorker = require('./ZipFileWorker'); + +/** + * Find the compression to use. + * @param {String} fileCompression the compression defined at the file level, if any. + * @param {String} zipCompression the compression defined at the load() level. + * @return {Object} the compression object to use. + */ +var getCompression = function (fileCompression, zipCompression) { + + var compressionName = fileCompression || zipCompression; + var compression = compressions[compressionName]; + if (!compression) { + throw new Error(compressionName + " is not a valid compression method !"); + } + return compression; +}; + +/** + * Create a worker to generate a zip file. + * @param {JSZip} zip the JSZip instance at the right root level. + * @param {Object} options to generate the zip file. + * @param {String} comment the comment to use. + */ +exports.generateWorker = function (zip, options, comment) { + + var zipFileWorker = new ZipFileWorker(options.streamFiles, comment, options.platform, options.encodeFileName); + var entriesCount = 0; + try { + + zip.forEach(function (relativePath, file) { + entriesCount++; + var compression = getCompression(file.options.compression, options.compression); + var compressionOptions = file.options.compressionOptions || options.compressionOptions || {}; + var dir = file.dir, date = file.date; + + file._compressWorker(compression, compressionOptions) + .withStreamInfo("file", { + name : relativePath, + dir : dir, + date : date, + comment : file.comment || "", + unixPermissions : file.unixPermissions, + dosPermissions : file.dosPermissions + }) + .pipe(zipFileWorker); + }); + zipFileWorker.entriesCount = entriesCount; + } catch (e) { + zipFileWorker.error(e); + } + + return zipFileWorker; +}; + +},{"../compressions":3,"./ZipFileWorker":8}],10:[function(require,module,exports){ +'use strict'; + +/** + * Representation a of zip file in js + * @constructor + */ +function JSZip() { + // if this constructor is used without `new`, it adds `new` before itself: + if(!(this instanceof JSZip)) { + return new JSZip(); + } + + if(arguments.length) { + throw new Error("The constructor with parameters has been removed in JSZip 3.0, please check the upgrade guide."); + } + + // object containing the files : + // { + // "folder/" : {...}, + // "folder/data.txt" : {...} + // } + this.files = {}; + + this.comment = null; + + // Where we are in the hierarchy + this.root = ""; + this.clone = function() { + var newObj = new JSZip(); + for (var i in this) { + if (typeof this[i] !== "function") { + newObj[i] = this[i]; + } + } + return newObj; + }; +} +JSZip.prototype = require('./object'); +JSZip.prototype.loadAsync = require('./load'); +JSZip.support = require('./support'); +JSZip.defaults = require('./defaults'); + +// TODO find a better way to handle this version, +// a require('package.json').version doesn't work with webpack, see #327 +JSZip.version = "3.1.5"; + +JSZip.loadAsync = function (content, options) { + return new JSZip().loadAsync(content, options); +}; + +JSZip.external = require("./external"); +module.exports = JSZip; + +},{"./defaults":5,"./external":6,"./load":11,"./object":15,"./support":30}],11:[function(require,module,exports){ +'use strict'; +var utils = require('./utils'); +var external = require("./external"); +var utf8 = require('./utf8'); +var utils = require('./utils'); +var ZipEntries = require('./zipEntries'); +var Crc32Probe = require('./stream/Crc32Probe'); +var nodejsUtils = require("./nodejsUtils"); + +/** + * Check the CRC32 of an entry. + * @param {ZipEntry} zipEntry the zip entry to check. + * @return {Promise} the result. + */ +function checkEntryCRC32(zipEntry) { + return new external.Promise(function (resolve, reject) { + var worker = zipEntry.decompressed.getContentWorker().pipe(new Crc32Probe()); + worker.on("error", function (e) { + reject(e); + }) + .on("end", function () { + if (worker.streamInfo.crc32 !== zipEntry.decompressed.crc32) { + reject(new Error("Corrupted zip : CRC32 mismatch")); + } else { + resolve(); + } + }) + .resume(); + }); +} + +module.exports = function(data, options) { + var zip = this; + options = utils.extend(options || {}, { + base64: false, + checkCRC32: false, + optimizedBinaryString: false, + createFolders: false, + decodeFileName: utf8.utf8decode + }); + + if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + return external.Promise.reject(new Error("JSZip can't accept a stream when loading a zip file.")); + } + + return utils.prepareContent("the loaded zip file", data, true, options.optimizedBinaryString, options.base64) + .then(function(data) { + var zipEntries = new ZipEntries(options); + zipEntries.load(data); + return zipEntries; + }).then(function checkCRC32(zipEntries) { + var promises = [external.Promise.resolve(zipEntries)]; + var files = zipEntries.files; + if (options.checkCRC32) { + for (var i = 0; i < files.length; i++) { + promises.push(checkEntryCRC32(files[i])); + } + } + return external.Promise.all(promises); + }).then(function addFiles(results) { + var zipEntries = results.shift(); + var files = zipEntries.files; + for (var i = 0; i < files.length; i++) { + var input = files[i]; + zip.file(input.fileNameStr, input.decompressed, { + binary: true, + optimizedBinaryString: true, + date: input.date, + dir: input.dir, + comment : input.fileCommentStr.length ? input.fileCommentStr : null, + unixPermissions : input.unixPermissions, + dosPermissions : input.dosPermissions, + createFolders: options.createFolders + }); + } + if (zipEntries.zipComment.length) { + zip.comment = zipEntries.zipComment; + } + + return zip; + }); +}; + +},{"./external":6,"./nodejsUtils":14,"./stream/Crc32Probe":25,"./utf8":31,"./utils":32,"./zipEntries":33}],12:[function(require,module,exports){ +"use strict"; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); + +/** + * A worker that use a nodejs stream as source. + * @constructor + * @param {String} filename the name of the file entry for this stream. + * @param {Readable} stream the nodejs stream. + */ +function NodejsStreamInputAdapter(filename, stream) { + GenericWorker.call(this, "Nodejs stream input adapter for " + filename); + this._upstreamEnded = false; + this._bindStream(stream); +} + +utils.inherits(NodejsStreamInputAdapter, GenericWorker); + +/** + * Prepare the stream and bind the callbacks on it. + * Do this ASAP on node 0.10 ! A lazy binding doesn't always work. + * @param {Stream} stream the nodejs stream to use. + */ +NodejsStreamInputAdapter.prototype._bindStream = function (stream) { + var self = this; + this._stream = stream; + stream.pause(); + stream + .on("data", function (chunk) { + self.push({ + data: chunk, + meta : { + percent : 0 + } + }); + }) + .on("error", function (e) { + if(self.isPaused) { + this.generatedError = e; + } else { + self.error(e); + } + }) + .on("end", function () { + if(self.isPaused) { + self._upstreamEnded = true; + } else { + self.end(); + } + }); +}; +NodejsStreamInputAdapter.prototype.pause = function () { + if(!GenericWorker.prototype.pause.call(this)) { + return false; + } + this._stream.pause(); + return true; +}; +NodejsStreamInputAdapter.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if(this._upstreamEnded) { + this.end(); + } else { + this._stream.resume(); + } + + return true; +}; + +module.exports = NodejsStreamInputAdapter; + +},{"../stream/GenericWorker":28,"../utils":32}],13:[function(require,module,exports){ +'use strict'; + +var Readable = require('readable-stream').Readable; + +var utils = require('../utils'); +utils.inherits(NodejsStreamOutputAdapter, Readable); + +/** +* A nodejs stream using a worker as source. +* @see the SourceWrapper in http://nodejs.org/api/stream.html +* @constructor +* @param {StreamHelper} helper the helper wrapping the worker +* @param {Object} options the nodejs stream options +* @param {Function} updateCb the update callback. +*/ +function NodejsStreamOutputAdapter(helper, options, updateCb) { + Readable.call(this, options); + this._helper = helper; + + var self = this; + helper.on("data", function (data, meta) { + if (!self.push(data)) { + self._helper.pause(); + } + if(updateCb) { + updateCb(meta); + } + }) + .on("error", function(e) { + self.emit('error', e); + }) + .on("end", function () { + self.push(null); + }); +} + + +NodejsStreamOutputAdapter.prototype._read = function() { + this._helper.resume(); +}; + +module.exports = NodejsStreamOutputAdapter; + +},{"../utils":32,"readable-stream":16}],14:[function(require,module,exports){ +'use strict'; + +module.exports = { + /** + * True if this is running in Nodejs, will be undefined in a browser. + * In a browser, browserify won't include this file and the whole module + * will be resolved an empty object. + */ + isNode : typeof Buffer !== "undefined", + /** + * Create a new nodejs Buffer from an existing content. + * @param {Object} data the data to pass to the constructor. + * @param {String} encoding the encoding to use. + * @return {Buffer} a new Buffer. + */ + newBufferFrom: function(data, encoding) { + // XXX We can't use `Buffer.from` which comes from `Uint8Array.from` + // in nodejs v4 (< v.4.5). It's not the expected implementation (and + // has a different signature). + // see https://github.com/nodejs/node/issues/8053 + // A condition on nodejs' version won't solve the issue as we don't + // control the Buffer polyfills that may or may not be used. + return new Buffer(data, encoding); + }, + /** + * Create a new nodejs Buffer with the specified size. + * @param {Integer} size the size of the buffer. + * @return {Buffer} a new Buffer. + */ + allocBuffer: function (size) { + if (Buffer.alloc) { + return Buffer.alloc(size); + } else { + return new Buffer(size); + } + }, + /** + * Find out if an object is a Buffer. + * @param {Object} b the object to test. + * @return {Boolean} true if the object is a Buffer, false otherwise. + */ + isBuffer : function(b){ + return Buffer.isBuffer(b); + }, + + isStream : function (obj) { + return obj && + typeof obj.on === "function" && + typeof obj.pause === "function" && + typeof obj.resume === "function"; + } +}; + +},{}],15:[function(require,module,exports){ +'use strict'; +var utf8 = require('./utf8'); +var utils = require('./utils'); +var GenericWorker = require('./stream/GenericWorker'); +var StreamHelper = require('./stream/StreamHelper'); +var defaults = require('./defaults'); +var CompressedObject = require('./compressedObject'); +var ZipObject = require('./zipObject'); +var generate = require("./generate"); +var nodejsUtils = require("./nodejsUtils"); +var NodejsStreamInputAdapter = require("./nodejs/NodejsStreamInputAdapter"); + + +/** + * Add a file in the current folder. + * @private + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data of the file + * @param {Object} originalOptions the options of the file + * @return {Object} the new file. + */ +var fileAdd = function(name, data, originalOptions) { + // be sure sub folders exist + var dataType = utils.getTypeOf(data), + parent; + + + /* + * Correct options. + */ + + var o = utils.extend(originalOptions || {}, defaults); + o.date = o.date || new Date(); + if (o.compression !== null) { + o.compression = o.compression.toUpperCase(); + } + + if (typeof o.unixPermissions === "string") { + o.unixPermissions = parseInt(o.unixPermissions, 8); + } + + // UNX_IFDIR 0040000 see zipinfo.c + if (o.unixPermissions && (o.unixPermissions & 0x4000)) { + o.dir = true; + } + // Bit 4 Directory + if (o.dosPermissions && (o.dosPermissions & 0x0010)) { + o.dir = true; + } + + if (o.dir) { + name = forceTrailingSlash(name); + } + if (o.createFolders && (parent = parentFolder(name))) { + folderAdd.call(this, parent, true); + } + + var isUnicodeString = dataType === "string" && o.binary === false && o.base64 === false; + if (!originalOptions || typeof originalOptions.binary === "undefined") { + o.binary = !isUnicodeString; + } + + + var isCompressedEmpty = (data instanceof CompressedObject) && data.uncompressedSize === 0; + + if (isCompressedEmpty || o.dir || !data || data.length === 0) { + o.base64 = false; + o.binary = true; + data = ""; + o.compression = "STORE"; + dataType = "string"; + } + + /* + * Convert content to fit. + */ + + var zipObjectContent = null; + if (data instanceof CompressedObject || data instanceof GenericWorker) { + zipObjectContent = data; + } else if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + zipObjectContent = new NodejsStreamInputAdapter(name, data); + } else { + zipObjectContent = utils.prepareContent(name, data, o.binary, o.optimizedBinaryString, o.base64); + } + + var object = new ZipObject(name, zipObjectContent, o); + this.files[name] = object; + /* + TODO: we can't throw an exception because we have async promises + (we can have a promise of a Date() for example) but returning a + promise is useless because file(name, data) returns the JSZip + object for chaining. Should we break that to allow the user + to catch the error ? + + return external.Promise.resolve(zipObjectContent) + .then(function () { + return object; + }); + */ +}; + +/** + * Find the parent folder of the path. + * @private + * @param {string} path the path to use + * @return {string} the parent folder, or "" + */ +var parentFolder = function (path) { + if (path.slice(-1) === '/') { + path = path.substring(0, path.length - 1); + } + var lastSlash = path.lastIndexOf('/'); + return (lastSlash > 0) ? path.substring(0, lastSlash) : ""; +}; + +/** + * Returns the path with a slash at the end. + * @private + * @param {String} path the path to check. + * @return {String} the path with a trailing slash. + */ +var forceTrailingSlash = function(path) { + // Check the name ends with a / + if (path.slice(-1) !== "/") { + path += "/"; // IE doesn't like substr(-1) + } + return path; +}; + +/** + * Add a (sub) folder in the current folder. + * @private + * @param {string} name the folder's name + * @param {boolean=} [createFolders] If true, automatically create sub + * folders. Defaults to false. + * @return {Object} the new folder. + */ +var folderAdd = function(name, createFolders) { + createFolders = (typeof createFolders !== 'undefined') ? createFolders : defaults.createFolders; + + name = forceTrailingSlash(name); + + // Does this folder already exist? + if (!this.files[name]) { + fileAdd.call(this, name, null, { + dir: true, + createFolders: createFolders + }); + } + return this.files[name]; +}; + +/** +* Cross-window, cross-Node-context regular expression detection +* @param {Object} object Anything +* @return {Boolean} true if the object is a regular expression, +* false otherwise +*/ +function isRegExp(object) { + return Object.prototype.toString.call(object) === "[object RegExp]"; +} + +// return the actual prototype of JSZip +var out = { + /** + * @see loadAsync + */ + load: function() { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + + /** + * Call a callback function for each entry at this folder level. + * @param {Function} cb the callback function: + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + */ + forEach: function(cb) { + var filename, relativePath, file; + for (filename in this.files) { + if (!this.files.hasOwnProperty(filename)) { + continue; + } + file = this.files[filename]; + relativePath = filename.slice(this.root.length, filename.length); + if (relativePath && filename.slice(0, this.root.length) === this.root) { // the file is in the current root + cb(relativePath, file); // TODO reverse the parameters ? need to be clean AND consistent with the filter search fn... + } + } + }, + + /** + * Filter nested files/folders with the specified function. + * @param {Function} search the predicate to use : + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + * @return {Array} An array of matching elements. + */ + filter: function(search) { + var result = []; + this.forEach(function (relativePath, entry) { + if (search(relativePath, entry)) { // the file matches the function + result.push(entry); + } + + }); + return result; + }, + + /** + * Add a file to the zip file, or search a file. + * @param {string|RegExp} name The name of the file to add (if data is defined), + * the name of the file to find (if no data) or a regex to match files. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data The file data, either raw or base64 encoded + * @param {Object} o File options + * @return {JSZip|Object|Array} this JSZip object (when adding a file), + * a file (when searching by string) or an array of files (when searching by regex). + */ + file: function(name, data, o) { + if (arguments.length === 1) { + if (isRegExp(name)) { + var regexp = name; + return this.filter(function(relativePath, file) { + return !file.dir && regexp.test(relativePath); + }); + } + else { // text + var obj = this.files[this.root + name]; + if (obj && !obj.dir) { + return obj; + } else { + return null; + } + } + } + else { // more than one argument : we have data ! + name = this.root + name; + fileAdd.call(this, name, data, o); + } + return this; + }, + + /** + * Add a directory to the zip file, or search. + * @param {String|RegExp} arg The name of the directory to add, or a regex to search folders. + * @return {JSZip} an object with the new directory as the root, or an array containing matching folders. + */ + folder: function(arg) { + if (!arg) { + return this; + } + + if (isRegExp(arg)) { + return this.filter(function(relativePath, file) { + return file.dir && arg.test(relativePath); + }); + } + + // else, name is a new folder + var name = this.root + arg; + var newFolder = folderAdd.call(this, name); + + // Allow chaining by returning a new object with this folder as the root + var ret = this.clone(); + ret.root = newFolder.name; + return ret; + }, + + /** + * Delete a file, or a directory and all sub-files, from the zip + * @param {string} name the name of the file to delete + * @return {JSZip} this JSZip object + */ + remove: function(name) { + name = this.root + name; + var file = this.files[name]; + if (!file) { + // Look for any folders + if (name.slice(-1) !== "/") { + name += "/"; + } + file = this.files[name]; + } + + if (file && !file.dir) { + // file + delete this.files[name]; + } else { + // maybe a folder, delete recursively + var kids = this.filter(function(relativePath, file) { + return file.name.slice(0, name.length) === name; + }); + for (var i = 0; i < kids.length; i++) { + delete this.files[kids[i].name]; + } + } + + return this; + }, + + /** + * Generate the complete zip file + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the zip file + */ + generate: function(options) { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + /** + * Generate the complete zip file as an internal stream. + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {StreamHelper} the streamed zip file. + */ + generateInternalStream: function(options) { + var worker, opts = {}; + try { + opts = utils.extend(options || {}, { + streamFiles: false, + compression: "STORE", + compressionOptions : null, + type: "", + platform: "DOS", + comment: null, + mimeType: 'application/zip', + encodeFileName: utf8.utf8encode + }); + + opts.type = opts.type.toLowerCase(); + opts.compression = opts.compression.toUpperCase(); + + // "binarystring" is prefered but the internals use "string". + if(opts.type === "binarystring") { + opts.type = "string"; + } + + if (!opts.type) { + throw new Error("No output type specified."); + } + + utils.checkSupport(opts.type); + + // accept nodejs `process.platform` + if( + opts.platform === 'darwin' || + opts.platform === 'freebsd' || + opts.platform === 'linux' || + opts.platform === 'sunos' + ) { + opts.platform = "UNIX"; + } + if (opts.platform === 'win32') { + opts.platform = "DOS"; + } + + var comment = opts.comment || this.comment || ""; + worker = generate.generateWorker(this, opts, comment); + } catch (e) { + worker = new GenericWorker("error"); + worker.error(e); + } + return new StreamHelper(worker, opts.type || "string", opts.mimeType); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateAsync: function(options, onUpdate) { + return this.generateInternalStream(options).accumulate(onUpdate); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateNodeStream: function(options, onUpdate) { + options = options || {}; + if (!options.type) { + options.type = "nodebuffer"; + } + return this.generateInternalStream(options).toNodejsStream(onUpdate); + } +}; +module.exports = out; + +},{"./compressedObject":2,"./defaults":5,"./generate":9,"./nodejs/NodejsStreamInputAdapter":12,"./nodejsUtils":14,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31,"./utils":32,"./zipObject":35}],16:[function(require,module,exports){ +/* + * This file is used by module bundlers (browserify/webpack/etc) when + * including a stream implementation. We use "readable-stream" to get a + * consistent behavior between nodejs versions but bundlers often have a shim + * for "stream". Using this shim greatly improve the compatibility and greatly + * reduce the final size of the bundle (only one stream implementation, not + * two). + */ +module.exports = require("stream"); + +},{"stream":undefined}],17:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function ArrayReader(data) { + DataReader.call(this, data); + for(var i = 0; i < this.data.length; i++) { + data[i] = data[i] & 0xFF; + } +} +utils.inherits(ArrayReader, DataReader); +/** + * @see DataReader.byteAt + */ +ArrayReader.prototype.byteAt = function(i) { + return this.data[this.zero + i]; +}; +/** + * @see DataReader.lastIndexOfSignature + */ +ArrayReader.prototype.lastIndexOfSignature = function(sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3); + for (var i = this.length - 4; i >= 0; --i) { + if (this.data[i] === sig0 && this.data[i + 1] === sig1 && this.data[i + 2] === sig2 && this.data[i + 3] === sig3) { + return i - this.zero; + } + } + + return -1; +}; +/** + * @see DataReader.readAndCheckSignature + */ +ArrayReader.prototype.readAndCheckSignature = function (sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3), + data = this.readData(4); + return sig0 === data[0] && sig1 === data[1] && sig2 === data[2] && sig3 === data[3]; +}; +/** + * @see DataReader.readData + */ +ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + return []; + } + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = ArrayReader; + +},{"../utils":32,"./DataReader":18}],18:[function(require,module,exports){ +'use strict'; +var utils = require('../utils'); + +function DataReader(data) { + this.data = data; // type : see implementation + this.length = data.length; + this.index = 0; + this.zero = 0; +} +DataReader.prototype = { + /** + * Check that the offset will not go too far. + * @param {string} offset the additional offset to check. + * @throws {Error} an Error if the offset is out of bounds. + */ + checkOffset: function(offset) { + this.checkIndex(this.index + offset); + }, + /** + * Check that the specified index will not be too far. + * @param {string} newIndex the index to check. + * @throws {Error} an Error if the index is out of bounds. + */ + checkIndex: function(newIndex) { + if (this.length < this.zero + newIndex || newIndex < 0) { + throw new Error("End of data reached (data length = " + this.length + ", asked index = " + (newIndex) + "). Corrupted zip ?"); + } + }, + /** + * Change the index. + * @param {number} newIndex The new index. + * @throws {Error} if the new index is out of the data. + */ + setIndex: function(newIndex) { + this.checkIndex(newIndex); + this.index = newIndex; + }, + /** + * Skip the next n bytes. + * @param {number} n the number of bytes to skip. + * @throws {Error} if the new index is out of the data. + */ + skip: function(n) { + this.setIndex(this.index + n); + }, + /** + * Get the byte at the specified index. + * @param {number} i the index to use. + * @return {number} a byte. + */ + byteAt: function(i) { + // see implementations + }, + /** + * Get the next number with a given byte size. + * @param {number} size the number of bytes to read. + * @return {number} the corresponding number. + */ + readInt: function(size) { + var result = 0, + i; + this.checkOffset(size); + for (i = this.index + size - 1; i >= this.index; i--) { + result = (result << 8) + this.byteAt(i); + } + this.index += size; + return result; + }, + /** + * Get the next string with a given byte size. + * @param {number} size the number of bytes to read. + * @return {string} the corresponding string. + */ + readString: function(size) { + return utils.transformTo("string", this.readData(size)); + }, + /** + * Get raw data without conversion, bytes. + * @param {number} size the number of bytes to read. + * @return {Object} the raw data, implementation specific. + */ + readData: function(size) { + // see implementations + }, + /** + * Find the last occurence of a zip signature (4 bytes). + * @param {string} sig the signature to find. + * @return {number} the index of the last occurence, -1 if not found. + */ + lastIndexOfSignature: function(sig) { + // see implementations + }, + /** + * Read the signature (4 bytes) at the current position and compare it with sig. + * @param {string} sig the expected signature + * @return {boolean} true if the signature matches, false otherwise. + */ + readAndCheckSignature: function(sig) { + // see implementations + }, + /** + * Get the next date. + * @return {Date} the date. + */ + readDate: function() { + var dostime = this.readInt(4); + return new Date(Date.UTC( + ((dostime >> 25) & 0x7f) + 1980, // year + ((dostime >> 21) & 0x0f) - 1, // month + (dostime >> 16) & 0x1f, // day + (dostime >> 11) & 0x1f, // hour + (dostime >> 5) & 0x3f, // minute + (dostime & 0x1f) << 1)); // second + } +}; +module.exports = DataReader; + +},{"../utils":32}],19:[function(require,module,exports){ +'use strict'; +var Uint8ArrayReader = require('./Uint8ArrayReader'); +var utils = require('../utils'); + +function NodeBufferReader(data) { + Uint8ArrayReader.call(this, data); +} +utils.inherits(NodeBufferReader, Uint8ArrayReader); + +/** + * @see DataReader.readData + */ +NodeBufferReader.prototype.readData = function(size) { + this.checkOffset(size); + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = NodeBufferReader; + +},{"../utils":32,"./Uint8ArrayReader":21}],20:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function StringReader(data) { + DataReader.call(this, data); +} +utils.inherits(StringReader, DataReader); +/** + * @see DataReader.byteAt + */ +StringReader.prototype.byteAt = function(i) { + return this.data.charCodeAt(this.zero + i); +}; +/** + * @see DataReader.lastIndexOfSignature + */ +StringReader.prototype.lastIndexOfSignature = function(sig) { + return this.data.lastIndexOf(sig) - this.zero; +}; +/** + * @see DataReader.readAndCheckSignature + */ +StringReader.prototype.readAndCheckSignature = function (sig) { + var data = this.readData(4); + return sig === data; +}; +/** + * @see DataReader.readData + */ +StringReader.prototype.readData = function(size) { + this.checkOffset(size); + // this will work because the constructor applied the "& 0xff" mask. + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = StringReader; + +},{"../utils":32,"./DataReader":18}],21:[function(require,module,exports){ +'use strict'; +var ArrayReader = require('./ArrayReader'); +var utils = require('../utils'); + +function Uint8ArrayReader(data) { + ArrayReader.call(this, data); +} +utils.inherits(Uint8ArrayReader, ArrayReader); +/** + * @see DataReader.readData + */ +Uint8ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + // in IE10, when using subarray(idx, idx), we get the array [0x00] instead of []. + return new Uint8Array(0); + } + var result = this.data.subarray(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = Uint8ArrayReader; + +},{"../utils":32,"./ArrayReader":17}],22:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var support = require('../support'); +var ArrayReader = require('./ArrayReader'); +var StringReader = require('./StringReader'); +var NodeBufferReader = require('./NodeBufferReader'); +var Uint8ArrayReader = require('./Uint8ArrayReader'); + +/** + * Create a reader adapted to the data. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data to read. + * @return {DataReader} the data reader. + */ +module.exports = function (data) { + var type = utils.getTypeOf(data); + utils.checkSupport(type); + if (type === "string" && !support.uint8array) { + return new StringReader(data); + } + if (type === "nodebuffer") { + return new NodeBufferReader(data); + } + if (support.uint8array) { + return new Uint8ArrayReader(utils.transformTo("uint8array", data)); + } + return new ArrayReader(utils.transformTo("array", data)); +}; + +},{"../support":30,"../utils":32,"./ArrayReader":17,"./NodeBufferReader":19,"./StringReader":20,"./Uint8ArrayReader":21}],23:[function(require,module,exports){ +'use strict'; +exports.LOCAL_FILE_HEADER = "PK\x03\x04"; +exports.CENTRAL_FILE_HEADER = "PK\x01\x02"; +exports.CENTRAL_DIRECTORY_END = "PK\x05\x06"; +exports.ZIP64_CENTRAL_DIRECTORY_LOCATOR = "PK\x06\x07"; +exports.ZIP64_CENTRAL_DIRECTORY_END = "PK\x06\x06"; +exports.DATA_DESCRIPTOR = "PK\x07\x08"; + +},{}],24:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var utils = require('../utils'); + +/** + * A worker which convert chunks to a specified type. + * @constructor + * @param {String} destType the destination type. + */ +function ConvertWorker(destType) { + GenericWorker.call(this, "ConvertWorker to " + destType); + this.destType = destType; +} +utils.inherits(ConvertWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +ConvertWorker.prototype.processChunk = function (chunk) { + this.push({ + data : utils.transformTo(this.destType, chunk.data), + meta : chunk.meta + }); +}; +module.exports = ConvertWorker; + +},{"../utils":32,"./GenericWorker":28}],25:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var crc32 = require('../crc32'); +var utils = require('../utils'); + +/** + * A worker which calculate the crc32 of the data flowing through. + * @constructor + */ +function Crc32Probe() { + GenericWorker.call(this, "Crc32Probe"); + this.withStreamInfo("crc32", 0); +} +utils.inherits(Crc32Probe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Crc32Probe.prototype.processChunk = function (chunk) { + this.streamInfo.crc32 = crc32(chunk.data, this.streamInfo.crc32 || 0); + this.push(chunk); +}; +module.exports = Crc32Probe; + +},{"../crc32":4,"../utils":32,"./GenericWorker":28}],26:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +/** + * A worker which calculate the total length of the data flowing through. + * @constructor + * @param {String} propName the name used to expose the length + */ +function DataLengthProbe(propName) { + GenericWorker.call(this, "DataLengthProbe for " + propName); + this.propName = propName; + this.withStreamInfo(propName, 0); +} +utils.inherits(DataLengthProbe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +DataLengthProbe.prototype.processChunk = function (chunk) { + if(chunk) { + var length = this.streamInfo[this.propName] || 0; + this.streamInfo[this.propName] = length + chunk.data.length; + } + GenericWorker.prototype.processChunk.call(this, chunk); +}; +module.exports = DataLengthProbe; + + +},{"../utils":32,"./GenericWorker":28}],27:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +// the size of the generated chunks +// TODO expose this as a public variable +var DEFAULT_BLOCK_SIZE = 16 * 1024; + +/** + * A worker that reads a content and emits chunks. + * @constructor + * @param {Promise} dataP the promise of the data to split + */ +function DataWorker(dataP) { + GenericWorker.call(this, "DataWorker"); + var self = this; + this.dataIsReady = false; + this.index = 0; + this.max = 0; + this.data = null; + this.type = ""; + + this._tickScheduled = false; + + dataP.then(function (data) { + self.dataIsReady = true; + self.data = data; + self.max = data && data.length || 0; + self.type = utils.getTypeOf(data); + if(!self.isPaused) { + self._tickAndRepeat(); + } + }, function (e) { + self.error(e); + }); +} + +utils.inherits(DataWorker, GenericWorker); + +/** + * @see GenericWorker.cleanUp + */ +DataWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this.data = null; +}; + +/** + * @see GenericWorker.resume + */ +DataWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this._tickScheduled && this.dataIsReady) { + this._tickScheduled = true; + utils.delay(this._tickAndRepeat, [], this); + } + return true; +}; + +/** + * Trigger a tick a schedule an other call to this function. + */ +DataWorker.prototype._tickAndRepeat = function() { + this._tickScheduled = false; + if(this.isPaused || this.isFinished) { + return; + } + this._tick(); + if(!this.isFinished) { + utils.delay(this._tickAndRepeat, [], this); + this._tickScheduled = true; + } +}; + +/** + * Read and push a chunk. + */ +DataWorker.prototype._tick = function() { + + if(this.isPaused || this.isFinished) { + return false; + } + + var size = DEFAULT_BLOCK_SIZE; + var data = null, nextIndex = Math.min(this.max, this.index + size); + if (this.index >= this.max) { + // EOF + return this.end(); + } else { + switch(this.type) { + case "string": + data = this.data.substring(this.index, nextIndex); + break; + case "uint8array": + data = this.data.subarray(this.index, nextIndex); + break; + case "array": + case "nodebuffer": + data = this.data.slice(this.index, nextIndex); + break; + } + this.index = nextIndex; + return this.push({ + data : data, + meta : { + percent : this.max ? this.index / this.max * 100 : 0 + } + }); + } +}; + +module.exports = DataWorker; + +},{"../utils":32,"./GenericWorker":28}],28:[function(require,module,exports){ +'use strict'; + +/** + * A worker that does nothing but passing chunks to the next one. This is like + * a nodejs stream but with some differences. On the good side : + * - it works on IE 6-9 without any issue / polyfill + * - it weights less than the full dependencies bundled with browserify + * - it forwards errors (no need to declare an error handler EVERYWHERE) + * + * A chunk is an object with 2 attributes : `meta` and `data`. The former is an + * object containing anything (`percent` for example), see each worker for more + * details. The latter is the real data (String, Uint8Array, etc). + * + * @constructor + * @param {String} name the name of the stream (mainly used for debugging purposes) + */ +function GenericWorker(name) { + // the name of the worker + this.name = name || "default"; + // an object containing metadata about the workers chain + this.streamInfo = {}; + // an error which happened when the worker was paused + this.generatedError = null; + // an object containing metadata to be merged by this worker into the general metadata + this.extraStreamInfo = {}; + // true if the stream is paused (and should not do anything), false otherwise + this.isPaused = true; + // true if the stream is finished (and should not do anything), false otherwise + this.isFinished = false; + // true if the stream is locked to prevent further structure updates (pipe), false otherwise + this.isLocked = false; + // the event listeners + this._listeners = { + 'data':[], + 'end':[], + 'error':[] + }; + // the previous worker, if any + this.previous = null; +} + +GenericWorker.prototype = { + /** + * Push a chunk to the next workers. + * @param {Object} chunk the chunk to push + */ + push : function (chunk) { + this.emit("data", chunk); + }, + /** + * End the stream. + * @return {Boolean} true if this call ended the worker, false otherwise. + */ + end : function () { + if (this.isFinished) { + return false; + } + + this.flush(); + try { + this.emit("end"); + this.cleanUp(); + this.isFinished = true; + } catch (e) { + this.emit("error", e); + } + return true; + }, + /** + * End the stream with an error. + * @param {Error} e the error which caused the premature end. + * @return {Boolean} true if this call ended the worker with an error, false otherwise. + */ + error : function (e) { + if (this.isFinished) { + return false; + } + + if(this.isPaused) { + this.generatedError = e; + } else { + this.isFinished = true; + + this.emit("error", e); + + // in the workers chain exploded in the middle of the chain, + // the error event will go downward but we also need to notify + // workers upward that there has been an error. + if(this.previous) { + this.previous.error(e); + } + + this.cleanUp(); + } + return true; + }, + /** + * Add a callback on an event. + * @param {String} name the name of the event (data, end, error) + * @param {Function} listener the function to call when the event is triggered + * @return {GenericWorker} the current object for chainability + */ + on : function (name, listener) { + this._listeners[name].push(listener); + return this; + }, + /** + * Clean any references when a worker is ending. + */ + cleanUp : function () { + this.streamInfo = this.generatedError = this.extraStreamInfo = null; + this._listeners = []; + }, + /** + * Trigger an event. This will call registered callback with the provided arg. + * @param {String} name the name of the event (data, end, error) + * @param {Object} arg the argument to call the callback with. + */ + emit : function (name, arg) { + if (this._listeners[name]) { + for(var i = 0; i < this._listeners[name].length; i++) { + this._listeners[name][i].call(this, arg); + } + } + }, + /** + * Chain a worker with an other. + * @param {Worker} next the worker receiving events from the current one. + * @return {worker} the next worker for chainability + */ + pipe : function (next) { + return next.registerPrevious(this); + }, + /** + * Same as `pipe` in the other direction. + * Using an API with `pipe(next)` is very easy. + * Implementing the API with the point of view of the next one registering + * a source is easier, see the ZipFileWorker. + * @param {Worker} previous the previous worker, sending events to this one + * @return {Worker} the current worker for chainability + */ + registerPrevious : function (previous) { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + + // sharing the streamInfo... + this.streamInfo = previous.streamInfo; + // ... and adding our own bits + this.mergeStreamInfo(); + this.previous = previous; + var self = this; + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.end(); + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; + }, + /** + * Pause the stream so it doesn't send events anymore. + * @return {Boolean} true if this call paused the worker, false otherwise. + */ + pause : function () { + if(this.isPaused || this.isFinished) { + return false; + } + this.isPaused = true; + + if(this.previous) { + this.previous.pause(); + } + return true; + }, + /** + * Resume a paused stream. + * @return {Boolean} true if this call resumed the worker, false otherwise. + */ + resume : function () { + if(!this.isPaused || this.isFinished) { + return false; + } + this.isPaused = false; + + // if true, the worker tried to resume but failed + var withError = false; + if(this.generatedError) { + this.error(this.generatedError); + withError = true; + } + if(this.previous) { + this.previous.resume(); + } + + return !withError; + }, + /** + * Flush any remaining bytes as the stream is ending. + */ + flush : function () {}, + /** + * Process a chunk. This is usually the method overridden. + * @param {Object} chunk the chunk to process. + */ + processChunk : function(chunk) { + this.push(chunk); + }, + /** + * Add a key/value to be added in the workers chain streamInfo once activated. + * @param {String} key the key to use + * @param {Object} value the associated value + * @return {Worker} the current worker for chainability + */ + withStreamInfo : function (key, value) { + this.extraStreamInfo[key] = value; + this.mergeStreamInfo(); + return this; + }, + /** + * Merge this worker's streamInfo into the chain's streamInfo. + */ + mergeStreamInfo : function () { + for(var key in this.extraStreamInfo) { + if (!this.extraStreamInfo.hasOwnProperty(key)) { + continue; + } + this.streamInfo[key] = this.extraStreamInfo[key]; + } + }, + + /** + * Lock the stream to prevent further updates on the workers chain. + * After calling this method, all calls to pipe will fail. + */ + lock: function () { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + this.isLocked = true; + if (this.previous) { + this.previous.lock(); + } + }, + + /** + * + * Pretty print the workers chain. + */ + toString : function () { + var me = "Worker " + this.name; + if (this.previous) { + return this.previous + " -> " + me; + } else { + return me; + } + } +}; + +module.exports = GenericWorker; + +},{}],29:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var ConvertWorker = require('./ConvertWorker'); +var GenericWorker = require('./GenericWorker'); +var base64 = require('../base64'); +var support = require("../support"); +var external = require("../external"); + +var NodejsStreamOutputAdapter = null; +if (support.nodestream) { + try { + NodejsStreamOutputAdapter = require('../nodejs/NodejsStreamOutputAdapter'); + } catch(e) {} +} + +/** + * Apply the final transformation of the data. If the user wants a Blob for + * example, it's easier to work with an U8intArray and finally do the + * ArrayBuffer/Blob conversion. + * @param {String} type the name of the final type + * @param {String|Uint8Array|Buffer} content the content to transform + * @param {String} mimeType the mime type of the content, if applicable. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the content in the right format. + */ +function transformZipOutput(type, content, mimeType) { + switch(type) { + case "blob" : + return utils.newBlob(utils.transformTo("arraybuffer", content), mimeType); + case "base64" : + return base64.encode(content); + default : + return utils.transformTo(type, content); + } +} + +/** + * Concatenate an array of data of the given type. + * @param {String} type the type of the data in the given array. + * @param {Array} dataArray the array containing the data chunks to concatenate + * @return {String|Uint8Array|Buffer} the concatenated data + * @throws Error if the asked type is unsupported + */ +function concat (type, dataArray) { + var i, index = 0, res = null, totalLength = 0; + for(i = 0; i < dataArray.length; i++) { + totalLength += dataArray[i].length; + } + switch(type) { + case "string": + return dataArray.join(""); + case "array": + return Array.prototype.concat.apply([], dataArray); + case "uint8array": + res = new Uint8Array(totalLength); + for(i = 0; i < dataArray.length; i++) { + res.set(dataArray[i], index); + index += dataArray[i].length; + } + return res; + case "nodebuffer": + return Buffer.concat(dataArray); + default: + throw new Error("concat : unsupported type '" + type + "'"); + } +} + +/** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {StreamHelper} helper the helper to use. + * @param {Function} updateCallback a callback called on each update. Called + * with one arg : + * - the metadata linked to the update received. + * @return Promise the promise for the accumulation. + */ +function accumulate(helper, updateCallback) { + return new external.Promise(function (resolve, reject){ + var dataArray = []; + var chunkType = helper._internalType, + resultType = helper._outputType, + mimeType = helper._mimeType; + helper + .on('data', function (data, meta) { + dataArray.push(data); + if(updateCallback) { + updateCallback(meta); + } + }) + .on('error', function(err) { + dataArray = []; + reject(err); + }) + .on('end', function (){ + try { + var result = transformZipOutput(resultType, concat(chunkType, dataArray), mimeType); + resolve(result); + } catch (e) { + reject(e); + } + dataArray = []; + }) + .resume(); + }); +} + +/** + * An helper to easily use workers outside of JSZip. + * @constructor + * @param {Worker} worker the worker to wrap + * @param {String} outputType the type of data expected by the use + * @param {String} mimeType the mime type of the content, if applicable. + */ +function StreamHelper(worker, outputType, mimeType) { + var internalType = outputType; + switch(outputType) { + case "blob": + case "arraybuffer": + internalType = "uint8array"; + break; + case "base64": + internalType = "string"; + break; + } + + try { + // the type used internally + this._internalType = internalType; + // the type used to output results + this._outputType = outputType; + // the mime type + this._mimeType = mimeType; + utils.checkSupport(internalType); + this._worker = worker.pipe(new ConvertWorker(internalType)); + // the last workers can be rewired without issues but we need to + // prevent any updates on previous workers. + worker.lock(); + } catch(e) { + this._worker = new GenericWorker("error"); + this._worker.error(e); + } +} + +StreamHelper.prototype = { + /** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {Function} updateCb the update callback. + * @return Promise the promise for the accumulation. + */ + accumulate : function (updateCb) { + return accumulate(this, updateCb); + }, + /** + * Add a listener on an event triggered on a stream. + * @param {String} evt the name of the event + * @param {Function} fn the listener + * @return {StreamHelper} the current helper. + */ + on : function (evt, fn) { + var self = this; + + if(evt === "data") { + this._worker.on(evt, function (chunk) { + fn.call(self, chunk.data, chunk.meta); + }); + } else { + this._worker.on(evt, function () { + utils.delay(fn, arguments, self); + }); + } + return this; + }, + /** + * Resume the flow of chunks. + * @return {StreamHelper} the current helper. + */ + resume : function () { + utils.delay(this._worker.resume, [], this._worker); + return this; + }, + /** + * Pause the flow of chunks. + * @return {StreamHelper} the current helper. + */ + pause : function () { + this._worker.pause(); + return this; + }, + /** + * Return a nodejs stream for this helper. + * @param {Function} updateCb the update callback. + * @return {NodejsStreamOutputAdapter} the nodejs stream. + */ + toNodejsStream : function (updateCb) { + utils.checkSupport("nodestream"); + if (this._outputType !== "nodebuffer") { + // an object stream containing blob/arraybuffer/uint8array/string + // is strange and I don't know if it would be useful. + // I you find this comment and have a good usecase, please open a + // bug report ! + throw new Error(this._outputType + " is not supported by this method"); + } + + return new NodejsStreamOutputAdapter(this, { + objectMode : this._outputType !== "nodebuffer" + }, updateCb); + } +}; + + +module.exports = StreamHelper; + +},{"../base64":1,"../external":6,"../nodejs/NodejsStreamOutputAdapter":13,"../support":30,"../utils":32,"./ConvertWorker":24,"./GenericWorker":28}],30:[function(require,module,exports){ +'use strict'; + +exports.base64 = true; +exports.array = true; +exports.string = true; +exports.arraybuffer = typeof ArrayBuffer !== "undefined" && typeof Uint8Array !== "undefined"; +exports.nodebuffer = typeof Buffer !== "undefined"; +// contains true if JSZip can read/generate Uint8Array, false otherwise. +exports.uint8array = typeof Uint8Array !== "undefined"; + +if (typeof ArrayBuffer === "undefined") { + exports.blob = false; +} +else { + var buffer = new ArrayBuffer(0); + try { + exports.blob = new Blob([buffer], { + type: "application/zip" + }).size === 0; + } + catch (e) { + try { + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(buffer); + exports.blob = builder.getBlob('application/zip').size === 0; + } + catch (e) { + exports.blob = false; + } + } +} + +try { + exports.nodestream = !!require('readable-stream').Readable; +} catch(e) { + exports.nodestream = false; +} + +},{"readable-stream":16}],31:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); +var support = require('./support'); +var nodejsUtils = require('./nodejsUtils'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * The following functions come from pako, from pako/lib/utils/strings + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Table with utf8 lengths (calculated by first byte of sequence) +// Note, that 5 & 6-byte values and some 4-byte values can not be represented in JS, +// because max possible codepoint is 0x10ffff +var _utf8len = new Array(256); +for (var i=0; i<256; i++) { + _utf8len[i] = (i >= 252 ? 6 : i >= 248 ? 5 : i >= 240 ? 4 : i >= 224 ? 3 : i >= 192 ? 2 : 1); +} +_utf8len[254]=_utf8len[254]=1; // Invalid sequence start + +// convert string to array (typed, when possible) +var string2buf = function (str) { + var buf, c, c2, m_pos, i, str_len = str.length, buf_len = 0; + + // count binary size + for (m_pos = 0; m_pos < str_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + buf_len += c < 0x80 ? 1 : c < 0x800 ? 2 : c < 0x10000 ? 3 : 4; + } + + // allocate buffer + if (support.uint8array) { + buf = new Uint8Array(buf_len); + } else { + buf = new Array(buf_len); + } + + // convert + for (i=0, m_pos = 0; i < buf_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + if (c < 0x80) { + /* one byte */ + buf[i++] = c; + } else if (c < 0x800) { + /* two bytes */ + buf[i++] = 0xC0 | (c >>> 6); + buf[i++] = 0x80 | (c & 0x3f); + } else if (c < 0x10000) { + /* three bytes */ + buf[i++] = 0xE0 | (c >>> 12); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } else { + /* four bytes */ + buf[i++] = 0xf0 | (c >>> 18); + buf[i++] = 0x80 | (c >>> 12 & 0x3f); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } + } + + return buf; +}; + +// Calculate max possible position in utf8 buffer, +// that will not break sequence. If that's not possible +// - (very small limits) return max size as is. +// +// buf[] - utf8 bytes array +// max - length limit (mandatory); +var utf8border = function(buf, max) { + var pos; + + max = max || buf.length; + if (max > buf.length) { max = buf.length; } + + // go back from last position, until start of sequence found + pos = max-1; + while (pos >= 0 && (buf[pos] & 0xC0) === 0x80) { pos--; } + + // Fuckup - very small and broken sequence, + // return max, because we should return something anyway. + if (pos < 0) { return max; } + + // If we came to start of buffer - that means vuffer is too small, + // return max too. + if (pos === 0) { return max; } + + return (pos + _utf8len[buf[pos]] > max) ? pos : max; +}; + +// convert array to string +var buf2string = function (buf) { + var str, i, out, c, c_len; + var len = buf.length; + + // Reserve max possible length (2 words per char) + // NB: by unknown reasons, Array is significantly faster for + // String.fromCharCode.apply than Uint16Array. + var utf16buf = new Array(len*2); + + for (out=0, i=0; i 4) { utf16buf[out++] = 0xfffd; i += c_len-1; continue; } + + // apply mask on first byte + c &= c_len === 2 ? 0x1f : c_len === 3 ? 0x0f : 0x07; + // join the rest + while (c_len > 1 && i < len) { + c = (c << 6) | (buf[i++] & 0x3f); + c_len--; + } + + // terminated by end of string? + if (c_len > 1) { utf16buf[out++] = 0xfffd; continue; } + + if (c < 0x10000) { + utf16buf[out++] = c; + } else { + c -= 0x10000; + utf16buf[out++] = 0xd800 | ((c >> 10) & 0x3ff); + utf16buf[out++] = 0xdc00 | (c & 0x3ff); + } + } + + // shrinkBuf(utf16buf, out) + if (utf16buf.length !== out) { + if(utf16buf.subarray) { + utf16buf = utf16buf.subarray(0, out); + } else { + utf16buf.length = out; + } + } + + // return String.fromCharCode.apply(null, utf16buf); + return utils.applyFromCharCode(utf16buf); +}; + + +// That's all for the pako functions. + + +/** + * Transform a javascript string into an array (typed if possible) of bytes, + * UTF-8 encoded. + * @param {String} str the string to encode + * @return {Array|Uint8Array|Buffer} the UTF-8 encoded string. + */ +exports.utf8encode = function utf8encode(str) { + if (support.nodebuffer) { + return nodejsUtils.newBufferFrom(str, "utf-8"); + } + + return string2buf(str); +}; + + +/** + * Transform a bytes array (or a representation) representing an UTF-8 encoded + * string into a javascript string. + * @param {Array|Uint8Array|Buffer} buf the data de decode + * @return {String} the decoded string. + */ +exports.utf8decode = function utf8decode(buf) { + if (support.nodebuffer) { + return utils.transformTo("nodebuffer", buf).toString("utf-8"); + } + + buf = utils.transformTo(support.uint8array ? "uint8array" : "array", buf); + + return buf2string(buf); +}; + +/** + * A worker to decode utf8 encoded binary chunks into string chunks. + * @constructor + */ +function Utf8DecodeWorker() { + GenericWorker.call(this, "utf-8 decode"); + // the last bytes if a chunk didn't end with a complete codepoint. + this.leftOver = null; +} +utils.inherits(Utf8DecodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8DecodeWorker.prototype.processChunk = function (chunk) { + + var data = utils.transformTo(support.uint8array ? "uint8array" : "array", chunk.data); + + // 1st step, re-use what's left of the previous chunk + if (this.leftOver && this.leftOver.length) { + if(support.uint8array) { + var previousData = data; + data = new Uint8Array(previousData.length + this.leftOver.length); + data.set(this.leftOver, 0); + data.set(previousData, this.leftOver.length); + } else { + data = this.leftOver.concat(data); + } + this.leftOver = null; + } + + var nextBoundary = utf8border(data); + var usableData = data; + if (nextBoundary !== data.length) { + if (support.uint8array) { + usableData = data.subarray(0, nextBoundary); + this.leftOver = data.subarray(nextBoundary, data.length); + } else { + usableData = data.slice(0, nextBoundary); + this.leftOver = data.slice(nextBoundary, data.length); + } + } + + this.push({ + data : exports.utf8decode(usableData), + meta : chunk.meta + }); +}; + +/** + * @see GenericWorker.flush + */ +Utf8DecodeWorker.prototype.flush = function () { + if(this.leftOver && this.leftOver.length) { + this.push({ + data : exports.utf8decode(this.leftOver), + meta : {} + }); + this.leftOver = null; + } +}; +exports.Utf8DecodeWorker = Utf8DecodeWorker; + +/** + * A worker to endcode string chunks into utf8 encoded binary chunks. + * @constructor + */ +function Utf8EncodeWorker() { + GenericWorker.call(this, "utf-8 encode"); +} +utils.inherits(Utf8EncodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8EncodeWorker.prototype.processChunk = function (chunk) { + this.push({ + data : exports.utf8encode(chunk.data), + meta : chunk.meta + }); +}; +exports.Utf8EncodeWorker = Utf8EncodeWorker; + +},{"./nodejsUtils":14,"./stream/GenericWorker":28,"./support":30,"./utils":32}],32:[function(require,module,exports){ +'use strict'; + +var support = require('./support'); +var base64 = require('./base64'); +var nodejsUtils = require('./nodejsUtils'); +var setImmediate = require('core-js/library/fn/set-immediate'); +var external = require("./external"); + + +/** + * Convert a string that pass as a "binary string": it should represent a byte + * array but may have > 255 char codes. Be sure to take only the first byte + * and returns the byte array. + * @param {String} str the string to transform. + * @return {Array|Uint8Array} the string in a binary format. + */ +function string2binary(str) { + var result = null; + if (support.uint8array) { + result = new Uint8Array(str.length); + } else { + result = new Array(str.length); + } + return stringToArrayLike(str, result); +} + +/** + * Create a new blob with the given content and the given type. + * @param {String|ArrayBuffer} part the content to put in the blob. DO NOT use + * an Uint8Array because the stock browser of android 4 won't accept it (it + * will be silently converted to a string, "[object Uint8Array]"). + * + * Use only ONE part to build the blob to avoid a memory leak in IE11 / Edge: + * when a large amount of Array is used to create the Blob, the amount of + * memory consumed is nearly 100 times the original data amount. + * + * @param {String} type the mime type of the blob. + * @return {Blob} the created blob. + */ +exports.newBlob = function(part, type) { + exports.checkSupport("blob"); + + try { + // Blob constructor + return new Blob([part], { + type: type + }); + } + catch (e) { + + try { + // deprecated, browser only, old way + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(part); + return builder.getBlob(type); + } + catch (e) { + + // well, fuck ?! + throw new Error("Bug : can't construct the Blob."); + } + } + + +}; +/** + * The identity function. + * @param {Object} input the input. + * @return {Object} the same input. + */ +function identity(input) { + return input; +} + +/** + * Fill in an array with a string. + * @param {String} str the string to use. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to fill in (will be mutated). + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated array. + */ +function stringToArrayLike(str, array) { + for (var i = 0; i < str.length; ++i) { + array[i] = str.charCodeAt(i) & 0xFF; + } + return array; +} + +/** + * An helper for the function arrayLikeToString. + * This contains static informations and functions that + * can be optimized by the browser JIT compiler. + */ +var arrayToStringHelper = { + /** + * Transform an array of int into a string, chunk by chunk. + * See the performances notes on arrayLikeToString. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @param {String} type the type of the array. + * @param {Integer} chunk the chunk size. + * @return {String} the resulting string. + * @throws Error if the chunk is too big for the stack. + */ + stringifyByChunk: function(array, type, chunk) { + var result = [], k = 0, len = array.length; + // shortcut + if (len <= chunk) { + return String.fromCharCode.apply(null, array); + } + while (k < len) { + if (type === "array" || type === "nodebuffer") { + result.push(String.fromCharCode.apply(null, array.slice(k, Math.min(k + chunk, len)))); + } + else { + result.push(String.fromCharCode.apply(null, array.subarray(k, Math.min(k + chunk, len)))); + } + k += chunk; + } + return result.join(""); + }, + /** + * Call String.fromCharCode on every item in the array. + * This is the naive implementation, which generate A LOT of intermediate string. + * This should be used when everything else fail. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ + stringifyByChar: function(array){ + var resultStr = ""; + for(var i = 0; i < array.length; i++) { + resultStr += String.fromCharCode(array[i]); + } + return resultStr; + }, + applyCanBeUsed : { + /** + * true if the browser accepts to use String.fromCharCode on Uint8Array + */ + uint8array : (function () { + try { + return support.uint8array && String.fromCharCode.apply(null, new Uint8Array(1)).length === 1; + } catch (e) { + return false; + } + })(), + /** + * true if the browser accepts to use String.fromCharCode on nodejs Buffer. + */ + nodebuffer : (function () { + try { + return support.nodebuffer && String.fromCharCode.apply(null, nodejsUtils.allocBuffer(1)).length === 1; + } catch (e) { + return false; + } + })() + } +}; + +/** + * Transform an array-like object to a string. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ +function arrayLikeToString(array) { + // Performances notes : + // -------------------- + // String.fromCharCode.apply(null, array) is the fastest, see + // see http://jsperf.com/converting-a-uint8array-to-a-string/2 + // but the stack is limited (and we can get huge arrays !). + // + // result += String.fromCharCode(array[i]); generate too many strings ! + // + // This code is inspired by http://jsperf.com/arraybuffer-to-string-apply-performance/2 + // TODO : we now have workers that split the work. Do we still need that ? + var chunk = 65536, + type = exports.getTypeOf(array), + canUseApply = true; + if (type === "uint8array") { + canUseApply = arrayToStringHelper.applyCanBeUsed.uint8array; + } else if (type === "nodebuffer") { + canUseApply = arrayToStringHelper.applyCanBeUsed.nodebuffer; + } + + if (canUseApply) { + while (chunk > 1) { + try { + return arrayToStringHelper.stringifyByChunk(array, type, chunk); + } catch (e) { + chunk = Math.floor(chunk / 2); + } + } + } + + // no apply or chunk error : slow and painful algorithm + // default browser on android 4.* + return arrayToStringHelper.stringifyByChar(array); +} + +exports.applyFromCharCode = arrayLikeToString; + + +/** + * Copy the data from an array-like to an other array-like. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayFrom the origin array. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayTo the destination array which will be mutated. + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated destination array. + */ +function arrayLikeToArrayLike(arrayFrom, arrayTo) { + for (var i = 0; i < arrayFrom.length; i++) { + arrayTo[i] = arrayFrom[i]; + } + return arrayTo; +} + +// a matrix containing functions to transform everything into everything. +var transform = {}; + +// string to ? +transform["string"] = { + "string": identity, + "array": function(input) { + return stringToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["string"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return stringToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": function(input) { + return stringToArrayLike(input, nodejsUtils.allocBuffer(input.length)); + } +}; + +// array to ? +transform["array"] = { + "string": arrayLikeToString, + "array": identity, + "arraybuffer": function(input) { + return (new Uint8Array(input)).buffer; + }, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// arraybuffer to ? +transform["arraybuffer"] = { + "string": function(input) { + return arrayLikeToString(new Uint8Array(input)); + }, + "array": function(input) { + return arrayLikeToArrayLike(new Uint8Array(input), new Array(input.byteLength)); + }, + "arraybuffer": identity, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(new Uint8Array(input)); + } +}; + +// uint8array to ? +transform["uint8array"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return input.buffer; + }, + "uint8array": identity, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// nodebuffer to ? +transform["nodebuffer"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["nodebuffer"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return arrayLikeToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": identity +}; + +/** + * Transform an input into any type. + * The supported output type are : string, array, uint8array, arraybuffer, nodebuffer. + * If no output type is specified, the unmodified input will be returned. + * @param {String} outputType the output type. + * @param {String|Array|ArrayBuffer|Uint8Array|Buffer} input the input to convert. + * @throws {Error} an Error if the browser doesn't support the requested output type. + */ +exports.transformTo = function(outputType, input) { + if (!input) { + // undefined, null, etc + // an empty string won't harm. + input = ""; + } + if (!outputType) { + return input; + } + exports.checkSupport(outputType); + var inputType = exports.getTypeOf(input); + var result = transform[inputType][outputType](input); + return result; +}; + +/** + * Return the type of the input. + * The type will be in a format valid for JSZip.utils.transformTo : string, array, uint8array, arraybuffer. + * @param {Object} input the input to identify. + * @return {String} the (lowercase) type of the input. + */ +exports.getTypeOf = function(input) { + if (typeof input === "string") { + return "string"; + } + if (Object.prototype.toString.call(input) === "[object Array]") { + return "array"; + } + if (support.nodebuffer && nodejsUtils.isBuffer(input)) { + return "nodebuffer"; + } + if (support.uint8array && input instanceof Uint8Array) { + return "uint8array"; + } + if (support.arraybuffer && input instanceof ArrayBuffer) { + return "arraybuffer"; + } +}; + +/** + * Throw an exception if the type is not supported. + * @param {String} type the type to check. + * @throws {Error} an Error if the browser doesn't support the requested type. + */ +exports.checkSupport = function(type) { + var supported = support[type.toLowerCase()]; + if (!supported) { + throw new Error(type + " is not supported by this platform"); + } +}; + +exports.MAX_VALUE_16BITS = 65535; +exports.MAX_VALUE_32BITS = -1; // well, "\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF" is parsed as -1 + +/** + * Prettify a string read as binary. + * @param {string} str the string to prettify. + * @return {string} a pretty string. + */ +exports.pretty = function(str) { + var res = '', + code, i; + for (i = 0; i < (str || "").length; i++) { + code = str.charCodeAt(i); + res += '\\x' + (code < 16 ? "0" : "") + code.toString(16).toUpperCase(); + } + return res; +}; + +/** + * Defer the call of a function. + * @param {Function} callback the function to call asynchronously. + * @param {Array} args the arguments to give to the callback. + */ +exports.delay = function(callback, args, self) { + setImmediate(function () { + callback.apply(self || null, args || []); + }); +}; + +/** + * Extends a prototype with an other, without calling a constructor with + * side effects. Inspired by nodejs' `utils.inherits` + * @param {Function} ctor the constructor to augment + * @param {Function} superCtor the parent constructor to use + */ +exports.inherits = function (ctor, superCtor) { + var Obj = function() {}; + Obj.prototype = superCtor.prototype; + ctor.prototype = new Obj(); +}; + +/** + * Merge the objects passed as parameters into a new one. + * @private + * @param {...Object} var_args All objects to merge. + * @return {Object} a new object with the data of the others. + */ +exports.extend = function() { + var result = {}, i, attr; + for (i = 0; i < arguments.length; i++) { // arguments is not enumerable in some browsers + for (attr in arguments[i]) { + if (arguments[i].hasOwnProperty(attr) && typeof result[attr] === "undefined") { + result[attr] = arguments[i][attr]; + } + } + } + return result; +}; + +/** + * Transform arbitrary content into a Promise. + * @param {String} name a name for the content being processed. + * @param {Object} inputData the content to process. + * @param {Boolean} isBinary true if the content is not an unicode string + * @param {Boolean} isOptimizedBinaryString true if the string content only has one byte per character. + * @param {Boolean} isBase64 true if the string content is encoded with base64. + * @return {Promise} a promise in a format usable by JSZip. + */ +exports.prepareContent = function(name, inputData, isBinary, isOptimizedBinaryString, isBase64) { + + // if inputData is already a promise, this flatten it. + var promise = external.Promise.resolve(inputData).then(function(data) { + + + var isBlob = support.blob && (data instanceof Blob || ['[object File]', '[object Blob]'].indexOf(Object.prototype.toString.call(data)) !== -1); + + if (isBlob && typeof FileReader !== "undefined") { + return new external.Promise(function (resolve, reject) { + var reader = new FileReader(); + + reader.onload = function(e) { + resolve(e.target.result); + }; + reader.onerror = function(e) { + reject(e.target.error); + }; + reader.readAsArrayBuffer(data); + }); + } else { + return data; + } + }); + + return promise.then(function(data) { + var dataType = exports.getTypeOf(data); + + if (!dataType) { + return external.Promise.reject( + new Error("Can't read the data of '" + name + "'. Is it " + + "in a supported JavaScript type (String, Blob, ArrayBuffer, etc) ?") + ); + } + // special case : it's way easier to work with Uint8Array than with ArrayBuffer + if (dataType === "arraybuffer") { + data = exports.transformTo("uint8array", data); + } else if (dataType === "string") { + if (isBase64) { + data = base64.decode(data); + } + else if (isBinary) { + // optimizedBinaryString === true means that the file has already been filtered with a 0xFF mask + if (isOptimizedBinaryString !== true) { + // this is a string, not in a base64 format. + // Be sure that this is a correct "binary string" + data = string2binary(data); + } + } + } + return data; + }); +}; + +},{"./base64":1,"./external":6,"./nodejsUtils":14,"./support":30,"core-js/library/fn/set-immediate":36}],33:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var sig = require('./signature'); +var ZipEntry = require('./zipEntry'); +var utf8 = require('./utf8'); +var support = require('./support'); +// class ZipEntries {{{ +/** + * All the entries in the zip file. + * @constructor + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntries(loadOptions) { + this.files = []; + this.loadOptions = loadOptions; +} +ZipEntries.prototype = { + /** + * Check that the reader is on the specified signature. + * @param {string} expectedSignature the expected signature. + * @throws {Error} if it is an other signature. + */ + checkSignature: function(expectedSignature) { + if (!this.reader.readAndCheckSignature(expectedSignature)) { + this.reader.index -= 4; + var signature = this.reader.readString(4); + throw new Error("Corrupted zip or bug: unexpected signature " + "(" + utils.pretty(signature) + ", expected " + utils.pretty(expectedSignature) + ")"); + } + }, + /** + * Check if the given signature is at the given index. + * @param {number} askedIndex the index to check. + * @param {string} expectedSignature the signature to expect. + * @return {boolean} true if the signature is here, false otherwise. + */ + isSignature: function(askedIndex, expectedSignature) { + var currentIndex = this.reader.index; + this.reader.setIndex(askedIndex); + var signature = this.reader.readString(4); + var result = signature === expectedSignature; + this.reader.setIndex(currentIndex); + return result; + }, + /** + * Read the end of the central directory. + */ + readBlockEndOfCentral: function() { + this.diskNumber = this.reader.readInt(2); + this.diskWithCentralDirStart = this.reader.readInt(2); + this.centralDirRecordsOnThisDisk = this.reader.readInt(2); + this.centralDirRecords = this.reader.readInt(2); + this.centralDirSize = this.reader.readInt(4); + this.centralDirOffset = this.reader.readInt(4); + + this.zipCommentLength = this.reader.readInt(2); + // warning : the encoding depends of the system locale + // On a linux machine with LANG=en_US.utf8, this field is utf8 encoded. + // On a windows machine, this field is encoded with the localized windows code page. + var zipComment = this.reader.readData(this.zipCommentLength); + var decodeParamType = support.uint8array ? "uint8array" : "array"; + // To get consistent behavior with the generation part, we will assume that + // this is utf8 encoded unless specified otherwise. + var decodeContent = utils.transformTo(decodeParamType, zipComment); + this.zipComment = this.loadOptions.decodeFileName(decodeContent); + }, + /** + * Read the end of the Zip 64 central directory. + * Not merged with the method readEndOfCentral : + * The end of central can coexist with its Zip64 brother, + * I don't want to read the wrong number of bytes ! + */ + readBlockZip64EndOfCentral: function() { + this.zip64EndOfCentralSize = this.reader.readInt(8); + this.reader.skip(4); + // this.versionMadeBy = this.reader.readString(2); + // this.versionNeeded = this.reader.readInt(2); + this.diskNumber = this.reader.readInt(4); + this.diskWithCentralDirStart = this.reader.readInt(4); + this.centralDirRecordsOnThisDisk = this.reader.readInt(8); + this.centralDirRecords = this.reader.readInt(8); + this.centralDirSize = this.reader.readInt(8); + this.centralDirOffset = this.reader.readInt(8); + + this.zip64ExtensibleData = {}; + var extraDataSize = this.zip64EndOfCentralSize - 44, + index = 0, + extraFieldId, + extraFieldLength, + extraFieldValue; + while (index < extraDataSize) { + extraFieldId = this.reader.readInt(2); + extraFieldLength = this.reader.readInt(4); + extraFieldValue = this.reader.readData(extraFieldLength); + this.zip64ExtensibleData[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + }, + /** + * Read the end of the Zip 64 central directory locator. + */ + readBlockZip64EndOfCentralLocator: function() { + this.diskWithZip64CentralDirStart = this.reader.readInt(4); + this.relativeOffsetEndOfZip64CentralDir = this.reader.readInt(8); + this.disksCount = this.reader.readInt(4); + if (this.disksCount > 1) { + throw new Error("Multi-volumes zip are not supported"); + } + }, + /** + * Read the local files, based on the offset read in the central part. + */ + readLocalFiles: function() { + var i, file; + for (i = 0; i < this.files.length; i++) { + file = this.files[i]; + this.reader.setIndex(file.localHeaderOffset); + this.checkSignature(sig.LOCAL_FILE_HEADER); + file.readLocalPart(this.reader); + file.handleUTF8(); + file.processAttributes(); + } + }, + /** + * Read the central directory. + */ + readCentralDir: function() { + var file; + + this.reader.setIndex(this.centralDirOffset); + while (this.reader.readAndCheckSignature(sig.CENTRAL_FILE_HEADER)) { + file = new ZipEntry({ + zip64: this.zip64 + }, this.loadOptions); + file.readCentralPart(this.reader); + this.files.push(file); + } + + if (this.centralDirRecords !== this.files.length) { + if (this.centralDirRecords !== 0 && this.files.length === 0) { + // We expected some records but couldn't find ANY. + // This is really suspicious, as if something went wrong. + throw new Error("Corrupted zip or bug: expected " + this.centralDirRecords + " records in central dir, got " + this.files.length); + } else { + // We found some records but not all. + // Something is wrong but we got something for the user: no error here. + // console.warn("expected", this.centralDirRecords, "records in central dir, got", this.files.length); + } + } + }, + /** + * Read the end of central directory. + */ + readEndOfCentral: function() { + var offset = this.reader.lastIndexOfSignature(sig.CENTRAL_DIRECTORY_END); + if (offset < 0) { + // Check if the content is a truncated zip or complete garbage. + // A "LOCAL_FILE_HEADER" is not required at the beginning (auto + // extractible zip for example) but it can give a good hint. + // If an ajax request was used without responseType, we will also + // get unreadable data. + var isGarbage = !this.isSignature(0, sig.LOCAL_FILE_HEADER); + + if (isGarbage) { + throw new Error("Can't find end of central directory : is this a zip file ? " + + "If it is, see https://stuk.github.io/jszip/documentation/howto/read_zip.html"); + } else { + throw new Error("Corrupted zip: can't find end of central directory"); + } + + } + this.reader.setIndex(offset); + var endOfCentralDirOffset = offset; + this.checkSignature(sig.CENTRAL_DIRECTORY_END); + this.readBlockEndOfCentral(); + + + /* extract from the zip spec : + 4) If one of the fields in the end of central directory + record is too small to hold required data, the field + should be set to -1 (0xFFFF or 0xFFFFFFFF) and the + ZIP64 format record should be created. + 5) The end of central directory record and the + Zip64 end of central directory locator record must + reside on the same disk when splitting or spanning + an archive. + */ + if (this.diskNumber === utils.MAX_VALUE_16BITS || this.diskWithCentralDirStart === utils.MAX_VALUE_16BITS || this.centralDirRecordsOnThisDisk === utils.MAX_VALUE_16BITS || this.centralDirRecords === utils.MAX_VALUE_16BITS || this.centralDirSize === utils.MAX_VALUE_32BITS || this.centralDirOffset === utils.MAX_VALUE_32BITS) { + this.zip64 = true; + + /* + Warning : the zip64 extension is supported, but ONLY if the 64bits integer read from + the zip file can fit into a 32bits integer. This cannot be solved : JavaScript represents + all numbers as 64-bit double precision IEEE 754 floating point numbers. + So, we have 53bits for integers and bitwise operations treat everything as 32bits. + see https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Operators/Bitwise_Operators + and http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-262.pdf section 8.5 + */ + + // should look for a zip64 EOCD locator + offset = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + if (offset < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory locator"); + } + this.reader.setIndex(offset); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + this.readBlockZip64EndOfCentralLocator(); + + // now the zip64 EOCD record + if (!this.isSignature(this.relativeOffsetEndOfZip64CentralDir, sig.ZIP64_CENTRAL_DIRECTORY_END)) { + // console.warn("ZIP64 end of central directory not where expected."); + this.relativeOffsetEndOfZip64CentralDir = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + if (this.relativeOffsetEndOfZip64CentralDir < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory"); + } + } + this.reader.setIndex(this.relativeOffsetEndOfZip64CentralDir); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + this.readBlockZip64EndOfCentral(); + } + + var expectedEndOfCentralDirOffset = this.centralDirOffset + this.centralDirSize; + if (this.zip64) { + expectedEndOfCentralDirOffset += 20; // end of central dir 64 locator + expectedEndOfCentralDirOffset += 12 /* should not include the leading 12 bytes */ + this.zip64EndOfCentralSize; + } + + var extraBytes = endOfCentralDirOffset - expectedEndOfCentralDirOffset; + + if (extraBytes > 0) { + // console.warn(extraBytes, "extra bytes at beginning or within zipfile"); + if (this.isSignature(endOfCentralDirOffset, sig.CENTRAL_FILE_HEADER)) { + // The offsets seem wrong, but we have something at the specified offset. + // So… we keep it. + } else { + // the offset is wrong, update the "zero" of the reader + // this happens if data has been prepended (crx files for example) + this.reader.zero = extraBytes; + } + } else if (extraBytes < 0) { + throw new Error("Corrupted zip: missing " + Math.abs(extraBytes) + " bytes."); + } + }, + prepareReader: function(data) { + this.reader = readerFor(data); + }, + /** + * Read a zip file and create ZipEntries. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the binary string representing a zip file. + */ + load: function(data) { + this.prepareReader(data); + this.readEndOfCentral(); + this.readCentralDir(); + this.readLocalFiles(); + } +}; +// }}} end of ZipEntries +module.exports = ZipEntries; + +},{"./reader/readerFor":22,"./signature":23,"./support":30,"./utf8":31,"./utils":32,"./zipEntry":34}],34:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var CompressedObject = require('./compressedObject'); +var crc32fn = require('./crc32'); +var utf8 = require('./utf8'); +var compressions = require('./compressions'); +var support = require('./support'); + +var MADE_BY_DOS = 0x00; +var MADE_BY_UNIX = 0x03; + +/** + * Find a compression registered in JSZip. + * @param {string} compressionMethod the method magic to find. + * @return {Object|null} the JSZip compression object, null if none found. + */ +var findCompression = function(compressionMethod) { + for (var method in compressions) { + if (!compressions.hasOwnProperty(method)) { + continue; + } + if (compressions[method].magic === compressionMethod) { + return compressions[method]; + } + } + return null; +}; + +// class ZipEntry {{{ +/** + * An entry in the zip file. + * @constructor + * @param {Object} options Options of the current file. + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntry(options, loadOptions) { + this.options = options; + this.loadOptions = loadOptions; +} +ZipEntry.prototype = { + /** + * say if the file is encrypted. + * @return {boolean} true if the file is encrypted, false otherwise. + */ + isEncrypted: function() { + // bit 1 is set + return (this.bitFlag & 0x0001) === 0x0001; + }, + /** + * say if the file has utf-8 filename/comment. + * @return {boolean} true if the filename/comment is in utf-8, false otherwise. + */ + useUTF8: function() { + // bit 11 is set + return (this.bitFlag & 0x0800) === 0x0800; + }, + /** + * Read the local part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readLocalPart: function(reader) { + var compression, localExtraFieldsLength; + + // we already know everything from the central dir ! + // If the central dir data are false, we are doomed. + // On the bright side, the local part is scary : zip64, data descriptors, both, etc. + // The less data we get here, the more reliable this should be. + // Let's skip the whole header and dash to the data ! + reader.skip(22); + // in some zip created on windows, the filename stored in the central dir contains \ instead of /. + // Strangely, the filename here is OK. + // I would love to treat these zip files as corrupted (see http://www.info-zip.org/FAQ.html#backslashes + // or APPNOTE#4.4.17.1, "All slashes MUST be forward slashes '/'") but there are a lot of bad zip generators... + // Search "unzip mismatching "local" filename continuing with "central" filename version" on + // the internet. + // + // I think I see the logic here : the central directory is used to display + // content and the local directory is used to extract the files. Mixing / and \ + // may be used to display \ to windows users and use / when extracting the files. + // Unfortunately, this lead also to some issues : http://seclists.org/fulldisclosure/2009/Sep/394 + this.fileNameLength = reader.readInt(2); + localExtraFieldsLength = reader.readInt(2); // can't be sure this will be the same as the central dir + // the fileName is stored as binary data, the handleUTF8 method will take care of the encoding. + this.fileName = reader.readData(this.fileNameLength); + reader.skip(localExtraFieldsLength); + + if (this.compressedSize === -1 || this.uncompressedSize === -1) { + throw new Error("Bug or corrupted zip : didn't get enough informations from the central directory " + "(compressedSize === -1 || uncompressedSize === -1)"); + } + + compression = findCompression(this.compressionMethod); + if (compression === null) { // no compression found + throw new Error("Corrupted zip : compression " + utils.pretty(this.compressionMethod) + " unknown (inner file : " + utils.transformTo("string", this.fileName) + ")"); + } + this.decompressed = new CompressedObject(this.compressedSize, this.uncompressedSize, this.crc32, compression, reader.readData(this.compressedSize)); + }, + + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readCentralPart: function(reader) { + this.versionMadeBy = reader.readInt(2); + reader.skip(2); + // this.versionNeeded = reader.readInt(2); + this.bitFlag = reader.readInt(2); + this.compressionMethod = reader.readString(2); + this.date = reader.readDate(); + this.crc32 = reader.readInt(4); + this.compressedSize = reader.readInt(4); + this.uncompressedSize = reader.readInt(4); + var fileNameLength = reader.readInt(2); + this.extraFieldsLength = reader.readInt(2); + this.fileCommentLength = reader.readInt(2); + this.diskNumberStart = reader.readInt(2); + this.internalFileAttributes = reader.readInt(2); + this.externalFileAttributes = reader.readInt(4); + this.localHeaderOffset = reader.readInt(4); + + if (this.isEncrypted()) { + throw new Error("Encrypted zip are not supported"); + } + + // will be read in the local part, see the comments there + reader.skip(fileNameLength); + this.readExtraFields(reader); + this.parseZIP64ExtraField(reader); + this.fileComment = reader.readData(this.fileCommentLength); + }, + + /** + * Parse the external file attributes and get the unix/dos permissions. + */ + processAttributes: function () { + this.unixPermissions = null; + this.dosPermissions = null; + var madeBy = this.versionMadeBy >> 8; + + // Check if we have the DOS directory flag set. + // We look for it in the DOS and UNIX permissions + // but some unknown platform could set it as a compatibility flag. + this.dir = this.externalFileAttributes & 0x0010 ? true : false; + + if(madeBy === MADE_BY_DOS) { + // first 6 bits (0 to 5) + this.dosPermissions = this.externalFileAttributes & 0x3F; + } + + if(madeBy === MADE_BY_UNIX) { + this.unixPermissions = (this.externalFileAttributes >> 16) & 0xFFFF; + // the octal permissions are in (this.unixPermissions & 0x01FF).toString(8); + } + + // fail safe : if the name ends with a / it probably means a folder + if (!this.dir && this.fileNameStr.slice(-1) === '/') { + this.dir = true; + } + }, + + /** + * Parse the ZIP64 extra field and merge the info in the current ZipEntry. + * @param {DataReader} reader the reader to use. + */ + parseZIP64ExtraField: function(reader) { + + if (!this.extraFields[0x0001]) { + return; + } + + // should be something, preparing the extra reader + var extraReader = readerFor(this.extraFields[0x0001].value); + + // I really hope that these 64bits integer can fit in 32 bits integer, because js + // won't let us have more. + if (this.uncompressedSize === utils.MAX_VALUE_32BITS) { + this.uncompressedSize = extraReader.readInt(8); + } + if (this.compressedSize === utils.MAX_VALUE_32BITS) { + this.compressedSize = extraReader.readInt(8); + } + if (this.localHeaderOffset === utils.MAX_VALUE_32BITS) { + this.localHeaderOffset = extraReader.readInt(8); + } + if (this.diskNumberStart === utils.MAX_VALUE_32BITS) { + this.diskNumberStart = extraReader.readInt(4); + } + }, + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readExtraFields: function(reader) { + var end = reader.index + this.extraFieldsLength, + extraFieldId, + extraFieldLength, + extraFieldValue; + + if (!this.extraFields) { + this.extraFields = {}; + } + + while (reader.index < end) { + extraFieldId = reader.readInt(2); + extraFieldLength = reader.readInt(2); + extraFieldValue = reader.readData(extraFieldLength); + + this.extraFields[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + }, + /** + * Apply an UTF8 transformation if needed. + */ + handleUTF8: function() { + var decodeParamType = support.uint8array ? "uint8array" : "array"; + if (this.useUTF8()) { + this.fileNameStr = utf8.utf8decode(this.fileName); + this.fileCommentStr = utf8.utf8decode(this.fileComment); + } else { + var upath = this.findExtraFieldUnicodePath(); + if (upath !== null) { + this.fileNameStr = upath; + } else { + // ASCII text or unsupported code page + var fileNameByteArray = utils.transformTo(decodeParamType, this.fileName); + this.fileNameStr = this.loadOptions.decodeFileName(fileNameByteArray); + } + + var ucomment = this.findExtraFieldUnicodeComment(); + if (ucomment !== null) { + this.fileCommentStr = ucomment; + } else { + // ASCII text or unsupported code page + var commentByteArray = utils.transformTo(decodeParamType, this.fileComment); + this.fileCommentStr = this.loadOptions.decodeFileName(commentByteArray); + } + } + }, + + /** + * Find the unicode path declared in the extra field, if any. + * @return {String} the unicode path, null otherwise. + */ + findExtraFieldUnicodePath: function() { + var upathField = this.extraFields[0x7075]; + if (upathField) { + var extraReader = readerFor(upathField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the filename changed, this field is out of date. + if (crc32fn(this.fileName) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(upathField.length - 5)); + } + return null; + }, + + /** + * Find the unicode comment declared in the extra field, if any. + * @return {String} the unicode comment, null otherwise. + */ + findExtraFieldUnicodeComment: function() { + var ucommentField = this.extraFields[0x6375]; + if (ucommentField) { + var extraReader = readerFor(ucommentField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the comment changed, this field is out of date. + if (crc32fn(this.fileComment) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(ucommentField.length - 5)); + } + return null; + } +}; +module.exports = ZipEntry; + +},{"./compressedObject":2,"./compressions":3,"./crc32":4,"./reader/readerFor":22,"./support":30,"./utf8":31,"./utils":32}],35:[function(require,module,exports){ +'use strict'; + +var StreamHelper = require('./stream/StreamHelper'); +var DataWorker = require('./stream/DataWorker'); +var utf8 = require('./utf8'); +var CompressedObject = require('./compressedObject'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * A simple object representing a file in the zip file. + * @constructor + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data + * @param {Object} options the options of the file + */ +var ZipObject = function(name, data, options) { + this.name = name; + this.dir = options.dir; + this.date = options.date; + this.comment = options.comment; + this.unixPermissions = options.unixPermissions; + this.dosPermissions = options.dosPermissions; + + this._data = data; + this._dataBinary = options.binary; + // keep only the compression + this.options = { + compression : options.compression, + compressionOptions : options.compressionOptions + }; +}; + +ZipObject.prototype = { + /** + * Create an internal stream for the content of this object. + * @param {String} type the type of each chunk. + * @return StreamHelper the stream. + */ + internalStream: function (type) { + var result = null, outputType = "string"; + try { + if (!type) { + throw new Error("No output type specified."); + } + outputType = type.toLowerCase(); + var askUnicodeString = outputType === "string" || outputType === "text"; + if (outputType === "binarystring" || outputType === "text") { + outputType = "string"; + } + result = this._decompressWorker(); + + var isUnicodeString = !this._dataBinary; + + if (isUnicodeString && !askUnicodeString) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + if (!isUnicodeString && askUnicodeString) { + result = result.pipe(new utf8.Utf8DecodeWorker()); + } + } catch (e) { + result = new GenericWorker("error"); + result.error(e); + } + + return new StreamHelper(result, outputType, ""); + }, + + /** + * Prepare the content in the asked type. + * @param {String} type the type of the result. + * @param {Function} onUpdate a function to call on each internal update. + * @return Promise the promise of the result. + */ + async: function (type, onUpdate) { + return this.internalStream(type).accumulate(onUpdate); + }, + + /** + * Prepare the content as a nodejs stream. + * @param {String} type the type of each chunk. + * @param {Function} onUpdate a function to call on each internal update. + * @return Stream the stream. + */ + nodeStream: function (type, onUpdate) { + return this.internalStream(type || "nodebuffer").toNodejsStream(onUpdate); + }, + + /** + * Return a worker for the compressed content. + * @private + * @param {Object} compression the compression object to use. + * @param {Object} compressionOptions the options to use when compressing. + * @return Worker the worker. + */ + _compressWorker: function (compression, compressionOptions) { + if ( + this._data instanceof CompressedObject && + this._data.compression.magic === compression.magic + ) { + return this._data.getCompressedWorker(); + } else { + var result = this._decompressWorker(); + if(!this._dataBinary) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + return CompressedObject.createWorkerFrom(result, compression, compressionOptions); + } + }, + /** + * Return a worker for the decompressed content. + * @private + * @return Worker the worker. + */ + _decompressWorker : function () { + if (this._data instanceof CompressedObject) { + return this._data.getContentWorker(); + } else if (this._data instanceof GenericWorker) { + return this._data; + } else { + return new DataWorker(this._data); + } + } +}; + +var removedMethods = ["asText", "asBinary", "asNodeBuffer", "asUint8Array", "asArrayBuffer"]; +var removedFn = function () { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); +}; + +for(var i = 0; i < removedMethods.length; i++) { + ZipObject.prototype[removedMethods[i]] = removedFn; +} +module.exports = ZipObject; + +},{"./compressedObject":2,"./stream/DataWorker":27,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31}],36:[function(require,module,exports){ +require('../modules/web.immediate'); +module.exports = require('../modules/_core').setImmediate; +},{"../modules/_core":40,"../modules/web.immediate":56}],37:[function(require,module,exports){ +module.exports = function(it){ + if(typeof it != 'function')throw TypeError(it + ' is not a function!'); + return it; +}; +},{}],38:[function(require,module,exports){ +var isObject = require('./_is-object'); +module.exports = function(it){ + if(!isObject(it))throw TypeError(it + ' is not an object!'); + return it; +}; +},{"./_is-object":51}],39:[function(require,module,exports){ +var toString = {}.toString; + +module.exports = function(it){ + return toString.call(it).slice(8, -1); +}; +},{}],40:[function(require,module,exports){ +var core = module.exports = {version: '2.3.0'}; +if(typeof __e == 'number')__e = core; // eslint-disable-line no-undef +},{}],41:[function(require,module,exports){ +// optional / simple context binding +var aFunction = require('./_a-function'); +module.exports = function(fn, that, length){ + aFunction(fn); + if(that === undefined)return fn; + switch(length){ + case 1: return function(a){ + return fn.call(that, a); + }; + case 2: return function(a, b){ + return fn.call(that, a, b); + }; + case 3: return function(a, b, c){ + return fn.call(that, a, b, c); + }; + } + return function(/* ...args */){ + return fn.apply(that, arguments); + }; +}; +},{"./_a-function":37}],42:[function(require,module,exports){ +// Thank's IE8 for his funny defineProperty +module.exports = !require('./_fails')(function(){ + return Object.defineProperty({}, 'a', {get: function(){ return 7; }}).a != 7; +}); +},{"./_fails":45}],43:[function(require,module,exports){ +var isObject = require('./_is-object') + , document = require('./_global').document + // in old IE typeof document.createElement is 'object' + , is = isObject(document) && isObject(document.createElement); +module.exports = function(it){ + return is ? document.createElement(it) : {}; +}; +},{"./_global":46,"./_is-object":51}],44:[function(require,module,exports){ +var global = require('./_global') + , core = require('./_core') + , ctx = require('./_ctx') + , hide = require('./_hide') + , PROTOTYPE = 'prototype'; + +var $export = function(type, name, source){ + var IS_FORCED = type & $export.F + , IS_GLOBAL = type & $export.G + , IS_STATIC = type & $export.S + , IS_PROTO = type & $export.P + , IS_BIND = type & $export.B + , IS_WRAP = type & $export.W + , exports = IS_GLOBAL ? core : core[name] || (core[name] = {}) + , expProto = exports[PROTOTYPE] + , target = IS_GLOBAL ? global : IS_STATIC ? global[name] : (global[name] || {})[PROTOTYPE] + , key, own, out; + if(IS_GLOBAL)source = name; + for(key in source){ + // contains in native + own = !IS_FORCED && target && target[key] !== undefined; + if(own && key in exports)continue; + // export native or passed + out = own ? target[key] : source[key]; + // prevent global pollution for namespaces + exports[key] = IS_GLOBAL && typeof target[key] != 'function' ? source[key] + // bind timers to global for call from export context + : IS_BIND && own ? ctx(out, global) + // wrap global constructors for prevent change them in library + : IS_WRAP && target[key] == out ? (function(C){ + var F = function(a, b, c){ + if(this instanceof C){ + switch(arguments.length){ + case 0: return new C; + case 1: return new C(a); + case 2: return new C(a, b); + } return new C(a, b, c); + } return C.apply(this, arguments); + }; + F[PROTOTYPE] = C[PROTOTYPE]; + return F; + // make static versions for prototype methods + })(out) : IS_PROTO && typeof out == 'function' ? ctx(Function.call, out) : out; + // export proto methods to core.%CONSTRUCTOR%.methods.%NAME% + if(IS_PROTO){ + (exports.virtual || (exports.virtual = {}))[key] = out; + // export proto methods to core.%CONSTRUCTOR%.prototype.%NAME% + if(type & $export.R && expProto && !expProto[key])hide(expProto, key, out); + } + } +}; +// type bitmap +$export.F = 1; // forced +$export.G = 2; // global +$export.S = 4; // static +$export.P = 8; // proto +$export.B = 16; // bind +$export.W = 32; // wrap +$export.U = 64; // safe +$export.R = 128; // real proto method for `library` +module.exports = $export; +},{"./_core":40,"./_ctx":41,"./_global":46,"./_hide":47}],45:[function(require,module,exports){ +module.exports = function(exec){ + try { + return !!exec(); + } catch(e){ + return true; + } +}; +},{}],46:[function(require,module,exports){ +// https://github.com/zloirock/core-js/issues/86#issuecomment-115759028 +var global = module.exports = typeof window != 'undefined' && window.Math == Math + ? window : typeof self != 'undefined' && self.Math == Math ? self : Function('return this')(); +if(typeof __g == 'number')__g = global; // eslint-disable-line no-undef +},{}],47:[function(require,module,exports){ +var dP = require('./_object-dp') + , createDesc = require('./_property-desc'); +module.exports = require('./_descriptors') ? function(object, key, value){ + return dP.f(object, key, createDesc(1, value)); +} : function(object, key, value){ + object[key] = value; + return object; +}; +},{"./_descriptors":42,"./_object-dp":52,"./_property-desc":53}],48:[function(require,module,exports){ +module.exports = require('./_global').document && document.documentElement; +},{"./_global":46}],49:[function(require,module,exports){ +module.exports = !require('./_descriptors') && !require('./_fails')(function(){ + return Object.defineProperty(require('./_dom-create')('div'), 'a', {get: function(){ return 7; }}).a != 7; +}); +},{"./_descriptors":42,"./_dom-create":43,"./_fails":45}],50:[function(require,module,exports){ +// fast apply, http://jsperf.lnkit.com/fast-apply/5 +module.exports = function(fn, args, that){ + var un = that === undefined; + switch(args.length){ + case 0: return un ? fn() + : fn.call(that); + case 1: return un ? fn(args[0]) + : fn.call(that, args[0]); + case 2: return un ? fn(args[0], args[1]) + : fn.call(that, args[0], args[1]); + case 3: return un ? fn(args[0], args[1], args[2]) + : fn.call(that, args[0], args[1], args[2]); + case 4: return un ? fn(args[0], args[1], args[2], args[3]) + : fn.call(that, args[0], args[1], args[2], args[3]); + } return fn.apply(that, args); +}; +},{}],51:[function(require,module,exports){ +module.exports = function(it){ + return typeof it === 'object' ? it !== null : typeof it === 'function'; +}; +},{}],52:[function(require,module,exports){ +var anObject = require('./_an-object') + , IE8_DOM_DEFINE = require('./_ie8-dom-define') + , toPrimitive = require('./_to-primitive') + , dP = Object.defineProperty; + +exports.f = require('./_descriptors') ? Object.defineProperty : function defineProperty(O, P, Attributes){ + anObject(O); + P = toPrimitive(P, true); + anObject(Attributes); + if(IE8_DOM_DEFINE)try { + return dP(O, P, Attributes); + } catch(e){ /* empty */ } + if('get' in Attributes || 'set' in Attributes)throw TypeError('Accessors not supported!'); + if('value' in Attributes)O[P] = Attributes.value; + return O; +}; +},{"./_an-object":38,"./_descriptors":42,"./_ie8-dom-define":49,"./_to-primitive":55}],53:[function(require,module,exports){ +module.exports = function(bitmap, value){ + return { + enumerable : !(bitmap & 1), + configurable: !(bitmap & 2), + writable : !(bitmap & 4), + value : value + }; +}; +},{}],54:[function(require,module,exports){ +var ctx = require('./_ctx') + , invoke = require('./_invoke') + , html = require('./_html') + , cel = require('./_dom-create') + , global = require('./_global') + , process = global.process + , setTask = global.setImmediate + , clearTask = global.clearImmediate + , MessageChannel = global.MessageChannel + , counter = 0 + , queue = {} + , ONREADYSTATECHANGE = 'onreadystatechange' + , defer, channel, port; +var run = function(){ + var id = +this; + if(queue.hasOwnProperty(id)){ + var fn = queue[id]; + delete queue[id]; + fn(); + } +}; +var listener = function(event){ + run.call(event.data); +}; +// Node.js 0.9+ & IE10+ has setImmediate, otherwise: +if(!setTask || !clearTask){ + setTask = function setImmediate(fn){ + var args = [], i = 1; + while(arguments.length > i)args.push(arguments[i++]); + queue[++counter] = function(){ + invoke(typeof fn == 'function' ? fn : Function(fn), args); + }; + defer(counter); + return counter; + }; + clearTask = function clearImmediate(id){ + delete queue[id]; + }; + // Node.js 0.8- + if(require('./_cof')(process) == 'process'){ + defer = function(id){ + process.nextTick(ctx(run, id, 1)); + }; + // Browsers with MessageChannel, includes WebWorkers + } else if(MessageChannel){ + channel = new MessageChannel; + port = channel.port2; + channel.port1.onmessage = listener; + defer = ctx(port.postMessage, port, 1); + // Browsers with postMessage, skip WebWorkers + // IE8 has postMessage, but it's sync & typeof its postMessage is 'object' + } else if(global.addEventListener && typeof postMessage == 'function' && !global.importScripts){ + defer = function(id){ + global.postMessage(id + '', '*'); + }; + global.addEventListener('message', listener, false); + // IE8- + } else if(ONREADYSTATECHANGE in cel('script')){ + defer = function(id){ + html.appendChild(cel('script'))[ONREADYSTATECHANGE] = function(){ + html.removeChild(this); + run.call(id); + }; + }; + // Rest old browsers + } else { + defer = function(id){ + setTimeout(ctx(run, id, 1), 0); + }; + } +} +module.exports = { + set: setTask, + clear: clearTask +}; +},{"./_cof":39,"./_ctx":41,"./_dom-create":43,"./_global":46,"./_html":48,"./_invoke":50}],55:[function(require,module,exports){ +// 7.1.1 ToPrimitive(input [, PreferredType]) +var isObject = require('./_is-object'); +// instead of the ES6 spec version, we didn't implement @@toPrimitive case +// and the second argument - flag - preferred type is a string +module.exports = function(it, S){ + if(!isObject(it))return it; + var fn, val; + if(S && typeof (fn = it.toString) == 'function' && !isObject(val = fn.call(it)))return val; + if(typeof (fn = it.valueOf) == 'function' && !isObject(val = fn.call(it)))return val; + if(!S && typeof (fn = it.toString) == 'function' && !isObject(val = fn.call(it)))return val; + throw TypeError("Can't convert object to primitive value"); +}; +},{"./_is-object":51}],56:[function(require,module,exports){ +var $export = require('./_export') + , $task = require('./_task'); +$export($export.G + $export.B, { + setImmediate: $task.set, + clearImmediate: $task.clear +}); +},{"./_export":44,"./_task":54}],57:[function(require,module,exports){ +(function (global){ +'use strict'; +var Mutation = global.MutationObserver || global.WebKitMutationObserver; + +var scheduleDrain; + +{ + if (Mutation) { + var called = 0; + var observer = new Mutation(nextTick); + var element = global.document.createTextNode(''); + observer.observe(element, { + characterData: true + }); + scheduleDrain = function () { + element.data = (called = ++called % 2); + }; + } else if (!global.setImmediate && typeof global.MessageChannel !== 'undefined') { + var channel = new global.MessageChannel(); + channel.port1.onmessage = nextTick; + scheduleDrain = function () { + channel.port2.postMessage(0); + }; + } else if ('document' in global && 'onreadystatechange' in global.document.createElement('script')) { + scheduleDrain = function () { + + // Create a + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/InvalidCredentialException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/InvalidCredentialException.html new file mode 100644 index 000000000..b14d4a1df --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/InvalidCredentialException.html @@ -0,0 +1,325 @@ + + + + + +InvalidCredentialException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/InvalidLocationException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/InvalidLocationException.html new file mode 100644 index 000000000..f6b7d7b5d --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/InvalidLocationException.html @@ -0,0 +1,325 @@ + + + + + +InvalidLocationException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/InvalidPropertyException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/InvalidPropertyException.html new file mode 100644 index 000000000..5c72cace0 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/InvalidPropertyException.html @@ -0,0 +1,325 @@ + + + + + +InvalidPropertyException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/PropertyTypeException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/PropertyTypeException.html new file mode 100644 index 000000000..511f8df18 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/PropertyTypeException.html @@ -0,0 +1,325 @@ + + + + + +PropertyTypeException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/UnknownAdaptorException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/UnknownAdaptorException.html new file mode 100644 index 000000000..e2062abbd --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/UnknownAdaptorException.html @@ -0,0 +1,323 @@ + + + + + +UnknownAdaptorException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/UnknownPropertyException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/UnknownPropertyException.html new file mode 100644 index 000000000..9571e2c47 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/UnknownPropertyException.html @@ -0,0 +1,325 @@ + + + + + +UnknownPropertyException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/UnsupportedOperationException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/UnsupportedOperationException.html new file mode 100644 index 000000000..cec693bc8 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/UnsupportedOperationException.html @@ -0,0 +1,323 @@ + + + + + +UnsupportedOperationException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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
      +
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        UnsupportedOperationException​(java.lang.String adaptorName, + java.lang.String message) 
        UnsupportedOperationException​(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

        + + + +
          +
        • +

          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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/XenonException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/XenonException.html new file mode 100644 index 000000000..982ac8b79 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/XenonException.html @@ -0,0 +1,361 @@ + + + + + +XenonException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package nl.esciencecenter.xenon
    +

    Class XenonException

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

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        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 TypeMethodDescription
        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
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/XenonPropertyDescription.Type.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/XenonPropertyDescription.Type.html new file mode 100644 index 000000000..c47855e60 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/XenonPropertyDescription.Type.html @@ -0,0 +1,470 @@ + + + + + +XenonPropertyDescription.Type (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package nl.esciencecenter.xenon
    +

    Enum XenonPropertyDescription.Type

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

        Enum Constant Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Enum Constants 
        Enum ConstantDescription
        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 TypeMethodDescription
        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
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/XenonPropertyDescription.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/XenonPropertyDescription.html new file mode 100644 index 000000000..bdfbb4005 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/XenonPropertyDescription.html @@ -0,0 +1,446 @@ + + + + + +XenonPropertyDescription (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 TypeClassDescription
        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 TypeMethodDescription
        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
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/XenonRuntimeException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/XenonRuntimeException.html new file mode 100644 index 000000000..51999291a --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/XenonRuntimeException.html @@ -0,0 +1,362 @@ + + + + + +XenonRuntimeException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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 TypeMethodDescription
        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
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/CertificateCredential.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/CertificateCredential.html new file mode 100644 index 000000000..acc1b7f75 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/CertificateCredential.html @@ -0,0 +1,395 @@ + + + + + +CertificateCredential (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package nl.esciencecenter.xenon.credentials
    +

    Class CertificateCredential

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

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        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.
          +
          +
          • +
        + + + + + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/Credential.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/Credential.html new file mode 100644 index 000000000..c335a5a0c --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/Credential.html @@ -0,0 +1,197 @@ + + + + + +Credential (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package nl.esciencecenter.xenon.credentials
    +

    Interface Credential

    +
    +
    +
    + +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/CredentialMap.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/CredentialMap.html new file mode 100644 index 000000000..3f87c1470 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/CredentialMap.html @@ -0,0 +1,476 @@ + + + + + +CredentialMap (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/DefaultCredential.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/DefaultCredential.html new file mode 100644 index 000000000..4527cbf84 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/DefaultCredential.html @@ -0,0 +1,371 @@ + + + + + +DefaultCredential (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 TypeMethodDescription
        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
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/KeytabCredential.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/KeytabCredential.html new file mode 100644 index 000000000..d8043139c --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/KeytabCredential.html @@ -0,0 +1,371 @@ + + + + + +KeytabCredential (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package nl.esciencecenter.xenon.credentials
    +

    Class KeytabCredential

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • nl.esciencecenter.xenon.credentials.KeytabCredential
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        KeytabCredential​(java.lang.String username, + java.lang.String keytabFile) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        booleanequals​(java.lang.Object obj) 
        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 obj)
          +
          +
          Overrides:
          +
          equals in class java.lang.Object
          +
          +
          • +
        + + + +
          +
        • +

          hashCode

          +
          public int hashCode()
          +
          +
          Overrides:
          +
          hashCode in class java.lang.Object
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/PasswordCredential.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/PasswordCredential.html new file mode 100644 index 000000000..0c7ba909d --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/PasswordCredential.html @@ -0,0 +1,434 @@ + + + + + +PasswordCredential (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package nl.esciencecenter.xenon.credentials
    +

    Class PasswordCredential

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • nl.esciencecenter.xenon.credentials.PasswordCredential
        • +
      +
      • +
    +
    + +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        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 TypeMethodDescription
        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
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/UserCredential.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/UserCredential.html new file mode 100644 index 000000000..be084dbcd --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/UserCredential.html @@ -0,0 +1,264 @@ + + + + + +UserCredential (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/package-summary.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/package-summary.html new file mode 100644 index 000000000..27fdf785b --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/package-summary.html @@ -0,0 +1,214 @@ + + + + + +nl.esciencecenter.xenon.credentials (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package nl.esciencecenter.xenon.credentials

    +
    +
    +
    + + +
    This package contains classes and interfaces for managing credentials.
    +
    +
      +
    • + + + + + + + + + + + + + + + + +
      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.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/package-tree.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/package-tree.html new file mode 100644 index 000000000..890ce230b --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/credentials/package-tree.html @@ -0,0 +1,178 @@ + + + + + +nl.esciencecenter.xenon.credentials Class Hierarchy (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package nl.esciencecenter.xenon.credentials

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/AttributeNotSupportedException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/AttributeNotSupportedException.html new file mode 100644 index 000000000..3cf782c51 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/AttributeNotSupportedException.html @@ -0,0 +1,325 @@ + + + + + +AttributeNotSupportedException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/CopyCancelledException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/CopyCancelledException.html new file mode 100644 index 000000000..646f1ea5d --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/CopyCancelledException.html @@ -0,0 +1,305 @@ + + + + + +CopyCancelledException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/CopyMode.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/CopyMode.html new file mode 100644 index 000000000..81ec97e62 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/CopyMode.html @@ -0,0 +1,405 @@ + + + + + +CopyMode (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 ConstantDescription
        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 TypeMethodDescription
        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
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/CopyStatus.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/CopyStatus.html new file mode 100644 index 000000000..c0808a005 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/CopyStatus.html @@ -0,0 +1,431 @@ + + + + + +CopyStatus (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 TypeMethodDescription
        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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/DirectoryNotEmptyException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/DirectoryNotEmptyException.html new file mode 100644 index 000000000..57d672ffa --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/DirectoryNotEmptyException.html @@ -0,0 +1,325 @@ + + + + + +DirectoryNotEmptyException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/FileSystem.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/FileSystem.html new file mode 100644 index 000000000..4b31168fd --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/FileSystem.html @@ -0,0 +1,1396 @@ + + + + + +FileSystem (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 TypeMethodDescription
        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
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/FileSystemAdaptorDescription.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/FileSystemAdaptorDescription.html new file mode 100644 index 000000000..f02a477e7 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/FileSystemAdaptorDescription.html @@ -0,0 +1,401 @@ + + + + + +FileSystemAdaptorDescription (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/FileSystemClosedException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/FileSystemClosedException.html new file mode 100644 index 000000000..e49ec46a0 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/FileSystemClosedException.html @@ -0,0 +1,325 @@ + + + + + +FileSystemClosedException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/InvalidOptionsException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/InvalidOptionsException.html new file mode 100644 index 000000000..5545088d7 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/InvalidOptionsException.html @@ -0,0 +1,325 @@ + + + + + +InvalidOptionsException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/InvalidPathException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/InvalidPathException.html new file mode 100644 index 000000000..022f3fade --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/InvalidPathException.html @@ -0,0 +1,325 @@ + + + + + +InvalidPathException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/InvalidResumeTargetException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/InvalidResumeTargetException.html new file mode 100644 index 000000000..12d19f878 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/InvalidResumeTargetException.html @@ -0,0 +1,325 @@ + + + + + +InvalidResumeTargetException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/NoSuchCopyException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/NoSuchCopyException.html new file mode 100644 index 000000000..ecba03dd2 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/NoSuchCopyException.html @@ -0,0 +1,325 @@ + + + + + +NoSuchCopyException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/NoSuchPathException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/NoSuchPathException.html new file mode 100644 index 000000000..0f3191b59 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/NoSuchPathException.html @@ -0,0 +1,325 @@ + + + + + +NoSuchPathException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/Path.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/Path.html new file mode 100644 index 000000000..c9b639792 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/Path.html @@ -0,0 +1,1069 @@ + + + + + +Path (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 TypeFieldDescription
        static charDEFAULT_SEPARATOR +
        The default separator to use.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        Path() +
        Create a new empty Path using the default separator.
        +
        Path​(boolean isAbsolute, + java.lang.String... elements) +
        Create a new Path using the given path elements and 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​(char separator, + boolean isAbsolute, + java.lang.String... elements) +
        Create a new Path using the given path elements and the provided 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, + 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 TypeMethodDescription
        booleanendsWith​(java.lang.String other) +
        Tests if this Path ends with the given Path represented as a String.
        +
        booleanendsWith​(Path other) +
        Tests if this Path ends with the given Path.
        +
        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​(java.lang.String other) +
        Resolve a Path represented as a String against this path.
        +
        Pathresolve​(Path other) +
        Resolve a Path against this Path.
        +
        PathresolveSibling​(Path other) +
        Resolves the given Path to this paths parent Path, thereby creating a sibling to this Path.
        +
        booleanstartsWith​(java.lang.String other) +
        Tests if this Path starts with the given Path represented as a String.
        +
        booleanstartsWith​(Path other) +
        Tests if this Path starts with the given Path.
        +
        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()
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/PathAlreadyExistsException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/PathAlreadyExistsException.html new file mode 100644 index 000000000..284ca65d7 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/PathAlreadyExistsException.html @@ -0,0 +1,325 @@ + + + + + +PathAlreadyExistsException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/PathAttributes.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/PathAttributes.html new file mode 100644 index 000000000..7fc685ff0 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/PathAttributes.html @@ -0,0 +1,588 @@ + + + + + +PathAttributes (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 TypeMethodDescription
        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.
          +
          +
          • +
        + + + + + + + + + + + + +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/PosixFilePermission.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/PosixFilePermission.html new file mode 100644 index 000000000..6d8ae0be3 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/PosixFilePermission.html @@ -0,0 +1,555 @@ + + + + + +PosixFilePermission (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 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.
          +
          +
          • +
        + + + +
          +
        • +

          convertToOctal

          +
          public static java.lang.String convertToOctal​(java.util.Set<PosixFilePermission> permissions)
          +
          • +
        + + + +
          +
        • +

          convertFromOctal

          +
          public static java.util.Set<PosixFilePermission> convertFromOctal​(java.lang.String octal)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/package-summary.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/package-summary.html new file mode 100644 index 000000000..a989b08cb --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/package-summary.html @@ -0,0 +1,296 @@ + + + + + +nl.esciencecenter.xenon.filesystems (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package nl.esciencecenter.xenon.filesystems

    +
    +
    +
    + + +
    This package contains classes and interfaces for manipulating files.
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + +
      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.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/package-tree.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/package-tree.html new file mode 100644 index 000000000..7f47aac4d --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/filesystems/package-tree.html @@ -0,0 +1,211 @@ + + + + + +nl.esciencecenter.xenon.filesystems Class Hierarchy (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    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) + +
        • +
      +
      • +
    +
    +
    +
    + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/package-summary.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/package-summary.html new file mode 100644 index 000000000..899ce51d8 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/package-summary.html @@ -0,0 +1,271 @@ + + + + + +nl.esciencecenter.xenon (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package nl.esciencecenter.xenon

    +
    +
    +
    + + +
    This package is the main entry point into the Xenon API.
    +
    +
      +
    • + + + + + + + + + + + + +
      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.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/package-tree.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/package-tree.html new file mode 100644 index 000000000..8993f04cb --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/package-tree.html @@ -0,0 +1,205 @@ + + + + + +nl.esciencecenter.xenon Class Hierarchy (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package nl.esciencecenter.xenon

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    +
      +
    • java.lang.Object + +
      • +
    +
    +
    +
    + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/IncompleteJobDescriptionException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/IncompleteJobDescriptionException.html new file mode 100644 index 000000000..0d3e2e7b1 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/IncompleteJobDescriptionException.html @@ -0,0 +1,325 @@ + + + + + +IncompleteJobDescriptionException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/InvalidJobDescriptionException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/InvalidJobDescriptionException.html new file mode 100644 index 000000000..fa275c2fd --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/InvalidJobDescriptionException.html @@ -0,0 +1,325 @@ + + + + + +InvalidJobDescriptionException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/JobDescription.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/JobDescription.html new file mode 100644 index 000000000..a26d7678b --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/JobDescription.html @@ -0,0 +1,1309 @@ + + + + + +JobDescription (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 TypeFieldDescription
        static java.lang.StringDEFAULT_START_TIME +
        The default start time
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        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 TypeMethodDescription
        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.
        +
        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.
        +
        intgetCoresPerTask() +
        Get the number of cores needed for each task.
        +
        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.
        +
        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.
        +
        java.lang.StringgetQueueName() +
        Get the queue name;
        +
        java.util.List<java.lang.String>getSchedulerArguments() +
        Get the scheduler specific arguments.
        +
        java.lang.StringgetStartTime() +
        Get the start time of the job.
        +
        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.
        +
        intgetTasks() +
        Get the number of tasks in this job.
        +
        intgetTasksPerNode() +
        Get the number of tasks per node.
        +
        intgetTempSpace() +
        Get the amount of temp space needed for process (in MBytes).
        +
        java.lang.StringgetWorkingDirectory() +
        Gets the path of the working directory for the executable.
        +
        inthashCode() 
        booleanisStartPerJob() +
        Will the executable be started per job? + + true by default.
        +
        booleanisStartPerTask() +
        Will the executable be started per task? + + false by default.
        +
        voidsetArguments​(java.lang.String... arguments) +
        Sets the command line arguments of the executable.
        +
        voidsetCoresPerTask​(int coresPerTask) +
        Set the number of cores needed for each task.
        +
        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.
        +
        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.
        +
        voidsetQueueName​(java.lang.String queueName) +
        Set the queue name;
        +
        voidsetSchedulerArguments​(java.lang.String... arguments) +
        Sets the scheduler specific arguments for this job.
        +
        voidsetStartPerJob() +
        Set if the executable must be started for once per job instead of for each task.
        +
        voidsetStartPerTask() +
        Set if the executable must be started for each task instead of once per job.
        +
        voidsetStartTime​(java.lang.String startTime) +
        Set the start time of the job.
        +
        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.
        +
        voidsetTasks​(int tasks) +
        Set the number of tasks in this job.
        +
        voidsetTasksPerNode​(int tasksPerNode) +
        Set the number of tasks allowed per node.
        +
        voidsetTempSpace​(int tempSpaceInMB) +
        Set the amount of memory needed for process (in MBytes).
        +
        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_START_TIME

          +
          public static final java.lang.String DEFAULT_START_TIME
          +
          The default start 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;
          +
          +
          • +
        + + + +
          +
        • +

          getTasks

          +
          public int getTasks()
          +
          Get the number of tasks in this job.
          +
          +
          Returns:
          +
          the number of tasks.
          +
          +
          • +
        + + + +
          +
        • +

          setTasks

          +
          public void setTasks​(int tasks)
          +
          Set the number of tasks in this job.
          +
          +
          Parameters:
          +
          tasks - the number of tasks;
          +
          +
          • +
        + + + +
          +
        • +

          getCoresPerTask

          +
          public int getCoresPerTask()
          +
          Get the number of cores needed for each task.
          +
          +
          Returns:
          +
          the number of cores needed for each task.
          +
          +
          • +
        + + + +
          +
        • +

          setCoresPerTask

          +
          public void setCoresPerTask​(int coresPerTask)
          +
          Set the number of cores needed for each task.
          +
          +
          Parameters:
          +
          coresPerTask - the number of cores needed for each task.
          +
          +
          • +
        + + + +
          +
        • +

          getTasksPerNode

          +
          public int getTasksPerNode()
          +
          Get the number of tasks per node.
          +
          +
          Returns:
          +
          the number of tasks per node.
          +
          +
          • +
        + + + +
          +
        • +

          setTasksPerNode

          +
          public void setTasksPerNode​(int tasksPerNode)
          +
          Set the number of tasks allowed per node.
          +
          +
          Parameters:
          +
          tasksPerNode - the number of tasks allowed per node.
          +
          +
          • +
        + + + +
          +
        • +

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

          getTempSpace

          +
          public int getTempSpace()
          +
          Get the amount of temp space needed for process (in MBytes).
          +
          +
          Returns:
          +
          the amount of temp space needed.
          +
          +
          • +
        + + + +
          +
        • +

          setTempSpace

          +
          public void setTempSpace​(int tempSpaceInMB)
          +
          Set the amount of memory needed for process (in MBytes).
          +
          +
          Parameters:
          +
          tempSpaceInMB - the amount of temp space needed per node/process.
          +
          +
          • +
        + + + +
          +
        • +

          isStartPerTask

          +
          public boolean isStartPerTask()
          +
          Will the executable be started per task? + + false by default.
          +
          +
          Returns:
          +
          if the executable is started per task.
          +
          +
          • +
        + + + +
          +
        • +

          isStartPerJob

          +
          public boolean isStartPerJob()
          +
          Will the executable be started per job? + + true by default.
          +
          +
          Returns:
          +
          if the executable is started per job.
          +
          +
          • +
        + + + +
          +
        • +

          setStartPerTask

          +
          public void setStartPerTask()
          +
          Set if the executable must be started for each task instead of once per job.
          +
          • +
        + + + +
          +
        • +

          setStartPerJob

          +
          public void setStartPerJob()
          +
          Set if the executable must be started for once per job instead of for each task.
          +
          • +
        + + + +
          +
        • +

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

          getStartTime

          +
          public java.lang.String getStartTime()
          +
          Get the start time of the job.
          +
          +
          Returns:
          +
          the start time of the job.
          +
          +
          • +
        + + + +
          +
        • +

          setStartTime

          +
          public void setStartTime​(java.lang.String startTime)
          +
          Set the start time of the job. + + Currently supported values are "now", or an explicit time and optional date in the format "HH:mm[ dd.MM[.YYYY]]"
          +
          +
          Parameters:
          +
          startTime - the start time of the job.
          +
          +
          • +
        + + + +
          +
        • +

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

          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
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/JobStatus.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/JobStatus.html new file mode 100644 index 000000000..b1dc5b60f --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/JobStatus.html @@ -0,0 +1,454 @@ + + + + + +JobStatus (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 TypeMethodDescription
        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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/NoSuchJobException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/NoSuchJobException.html new file mode 100644 index 000000000..df610d1a6 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/NoSuchJobException.html @@ -0,0 +1,325 @@ + + + + + +NoSuchJobException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/NoSuchQueueException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/NoSuchQueueException.html new file mode 100644 index 000000000..d9425dd5b --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/NoSuchQueueException.html @@ -0,0 +1,325 @@ + + + + + +NoSuchQueueException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/QueueStatus.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/QueueStatus.html new file mode 100644 index 000000000..e58914b8c --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/QueueStatus.html @@ -0,0 +1,365 @@ + + + + + +QueueStatus (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/Scheduler.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/Scheduler.html new file mode 100644 index 000000000..e44e3b3ed --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/Scheduler.html @@ -0,0 +1,1094 @@ + + + + + +Scheduler (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 TypeMethodDescription
        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 intgetDefaultRuntime() +
        Get the default runtime of a job in minutes.
        +
        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.
          +
          +
          • +
        + + + +
          +
        • +

          getDefaultRuntime

          +
          public abstract int getDefaultRuntime()
+                               throws XenonException
          +
          Get the default runtime of a job in minutes. + + If no default runtime is available, -1 will be returned. If the default runtime is infinite, 0 will be returned.
          +
          +
          Returns:
          +
          the default runtime of a job in minutes, -1 if no default is available, 0 if the default is infinite.
          +
          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
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/SchedulerAdaptorDescription.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/SchedulerAdaptorDescription.html new file mode 100644 index 000000000..91e579289 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/SchedulerAdaptorDescription.html @@ -0,0 +1,353 @@ + + + + + +SchedulerAdaptorDescription (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package nl.esciencecenter.xenon.schedulers
    +

    Interface SchedulerAdaptorDescription

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

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Abstract Methods 
        Modifier and TypeMethodDescription
        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 ?
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/Streams.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/Streams.html new file mode 100644 index 000000000..fa0fbfcb1 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/Streams.html @@ -0,0 +1,325 @@ + + + + + +Streams (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 TypeMethodDescription
        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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/UnsupportedJobDescriptionException.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/UnsupportedJobDescriptionException.html new file mode 100644 index 000000000..74a417860 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/UnsupportedJobDescriptionException.html @@ -0,0 +1,325 @@ + + + + + +UnsupportedJobDescriptionException (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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)
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/package-summary.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/package-summary.html new file mode 100644 index 000000000..d44cfb9fa --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/package-summary.html @@ -0,0 +1,251 @@ + + + + + +nl.esciencecenter.xenon.schedulers (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package nl.esciencecenter.xenon.schedulers

    +
    +
    +
    + + +
    This package contains the classes and interfaces used to run jobs.
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + +
      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.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/package-tree.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/package-tree.html new file mode 100644 index 000000000..be31c8db0 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/schedulers/package-tree.html @@ -0,0 +1,192 @@ + + + + + +nl.esciencecenter.xenon.schedulers Class Hierarchy (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package nl.esciencecenter.xenon.schedulers

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +
    + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/DaemonThreadFactory.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/DaemonThreadFactory.html new file mode 100644 index 000000000..65f877ce8 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/DaemonThreadFactory.html @@ -0,0 +1,313 @@ + + + + + +DaemonThreadFactory (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package nl.esciencecenter.xenon.utils
    +

    Class DaemonThreadFactory

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • nl.esciencecenter.xenon.utils.DaemonThreadFactory
        • +
      +
      • +
    +
    +
      +
    • +
      +
      All Implemented Interfaces:
      +
      java.util.concurrent.ThreadFactory
      +
      +
      +
      public class DaemonThreadFactory
+extends java.lang.Object
+implements java.util.concurrent.ThreadFactory
      +
      • +
    +
    +
    +
      +
    • + +
      +
        +
      • + + +

        Constructor Summary

        + + + + + + + + + + +
        Constructors 
        ConstructorDescription
        DaemonThreadFactory​(java.lang.String name) 
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

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

          Methods inherited from class java.lang.Object

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

        Constructor Detail

        + + + +
          +
        • +

          DaemonThreadFactory

          +
          public DaemonThreadFactory​(java.lang.String name)
          +
          • +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          newThread

          +
          public java.lang.Thread newThread​(java.lang.Runnable runnable)
          +
          +
          Specified by:
          +
          newThread in interface java.util.concurrent.ThreadFactory
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/InputWriter.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/InputWriter.html new file mode 100644 index 000000000..54484b8cd --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/InputWriter.html @@ -0,0 +1,413 @@ + + + + + +InputWriter (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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 TypeMethodDescription
        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, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, 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
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/JavaJobDescription.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/JavaJobDescription.html new file mode 100644 index 000000000..bcb42ef07 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/JavaJobDescription.html @@ -0,0 +1,758 @@ + + + + + +JavaJobDescription (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/LocalFileSystemUtils.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/LocalFileSystemUtils.html new file mode 100644 index 000000000..2a693e60f --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/LocalFileSystemUtils.html @@ -0,0 +1,626 @@ + + + + + +LocalFileSystemUtils (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 TypeMethodDescription
        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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/OutputReader.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/OutputReader.html new file mode 100644 index 000000000..da3c20ef2 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/OutputReader.html @@ -0,0 +1,458 @@ + + + + + +OutputReader (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        OutputReader​(java.io.InputStream source) +
        Create an OutputReader that reads from source.
        +
        +
        • +
      +
      + +
      +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        All Methods Instance Methods Concrete Methods 
        Modifier and TypeMethodDescription
        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, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, 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.
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/StreamForwarder.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/StreamForwarder.html new file mode 100644 index 000000000..fcabd8cd5 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/StreamForwarder.html @@ -0,0 +1,426 @@ + + + + + +StreamForwarder (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    + +
    +
    +
    Package 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 
        ConstructorDescription
        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 TypeMethodDescription
        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, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, 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
          +
          +
          • +
        +
        • +
      +
      +
      • +
    +
    +
    +
    + + + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/package-summary.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/package-summary.html new file mode 100644 index 000000000..f7262ecc7 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/package-summary.html @@ -0,0 +1,197 @@ + + + + + +nl.esciencecenter.xenon.utils (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Package nl.esciencecenter.xenon.utils

    +
    +
    +
    + + +
    This package is contains several utility classes.
    +
    +
      +
    • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      DaemonThreadFactory 
      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.
      +
      +
      • +
    +
    +
    +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/package-tree.html b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/package-tree.html new file mode 100644 index 000000000..be2224595 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/nl/esciencecenter/xenon/utils/package-tree.html @@ -0,0 +1,174 @@ + + + + + +nl.esciencecenter.xenon.utils Class Hierarchy (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For Package nl.esciencecenter.xenon.utils

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +
    + + + diff --git a/docs/versions/3.0.1/javadoc/overview-summary.html b/docs/versions/3.0.1/javadoc/overview-summary.html new file mode 100644 index 000000000..88a3452df --- /dev/null +++ b/docs/versions/3.0.1/javadoc/overview-summary.html @@ -0,0 +1,23 @@ + + + + + +xenon 3.0.1 API + + + + + + + +
    + +

    index.html

    +
    + + diff --git a/docs/versions/3.0.1/javadoc/overview-tree.html b/docs/versions/3.0.1/javadoc/overview-tree.html new file mode 100644 index 000000000..bbe430584 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/overview-tree.html @@ -0,0 +1,266 @@ + + + + + +Class Hierarchy (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Hierarchy For All Packages

    +Package Hierarchies: + +
    +
    +
    +

    Class Hierarchy

    + +
    +
    +

    Interface Hierarchy

    + +
    +
    +

    Enum Hierarchy

    + +
    +
    +
    +
    + +
    + + diff --git a/docs/versions/3.0.1/javadoc/package-search-index.js b/docs/versions/3.0.1/javadoc/package-search-index.js new file mode 100644 index 000000000..1c3194994 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","url":"allpackages-index.html"},{"l":"nl.esciencecenter.xenon"},{"l":"nl.esciencecenter.xenon.credentials"},{"l":"nl.esciencecenter.xenon.filesystems"},{"l":"nl.esciencecenter.xenon.schedulers"},{"l":"nl.esciencecenter.xenon.utils"}] \ No newline at end of file diff --git a/docs/versions/3.0.1/javadoc/package-search-index.zip b/docs/versions/3.0.1/javadoc/package-search-index.zip new file mode 100644 index 000000000..fd943eab3 Binary files /dev/null and b/docs/versions/3.0.1/javadoc/package-search-index.zip differ diff --git a/docs/versions/3.0.1/javadoc/resources/glass.png b/docs/versions/3.0.1/javadoc/resources/glass.png new file mode 100644 index 000000000..a7f591f46 Binary files /dev/null and b/docs/versions/3.0.1/javadoc/resources/glass.png differ diff --git a/docs/versions/3.0.1/javadoc/resources/x.png b/docs/versions/3.0.1/javadoc/resources/x.png new file mode 100644 index 000000000..30548a756 Binary files /dev/null and b/docs/versions/3.0.1/javadoc/resources/x.png differ diff --git a/docs/versions/3.0.1/javadoc/script.js b/docs/versions/3.0.1/javadoc/script.js new file mode 100644 index 000000000..0eaaf5358 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/script.js @@ -0,0 +1,139 @@ +/* + * Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; +function loadScripts(doc, tag) { + createElem(doc, tag, 'jquery/jszip/dist/jszip.js'); + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils.js'); + if (window.navigator.userAgent.indexOf('MSIE ') > 0 || window.navigator.userAgent.indexOf('Trident/') > 0 || + window.navigator.userAgent.indexOf('Edge/') > 0) { + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils-ie.js'); + } + createElem(doc, tag, 'search.js'); + + $.get(pathtoroot + "module-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "module-search-index.zip", function(e, data) { + var zip = new JSZip(data); + zip.load(data); + moduleSearchIndex = JSON.parse(zip.file("module-search-index.json").asText()); + }); + }); + $.get(pathtoroot + "package-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "package-search-index.zip", function(e, data) { + var zip = new JSZip(data); + zip.load(data); + packageSearchIndex = JSON.parse(zip.file("package-search-index.json").asText()); + }); + }); + $.get(pathtoroot + "type-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "type-search-index.zip", function(e, data) { + var zip = new JSZip(data); + zip.load(data); + typeSearchIndex = JSON.parse(zip.file("type-search-index.json").asText()); + }); + }); + $.get(pathtoroot + "member-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "member-search-index.zip", function(e, data) { + var zip = new JSZip(data); + zip.load(data); + memberSearchIndex = JSON.parse(zip.file("member-search-index.json").asText()); + }); + }); + $.get(pathtoroot + "tag-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "tag-search-index.zip", function(e, data) { + var zip = new JSZip(data); + zip.load(data); + tagSearchIndex = JSON.parse(zip.file("tag-search-index.json").asText()); + }); + }); + if (!moduleSearchIndex) { + createElem(doc, tag, 'module-search-index.js'); + } + if (!packageSearchIndex) { + createElem(doc, tag, 'package-search-index.js'); + } + if (!typeSearchIndex) { + createElem(doc, tag, 'type-search-index.js'); + } + if (!memberSearchIndex) { + createElem(doc, tag, 'member-search-index.js'); + } + if (!tagSearchIndex) { + createElem(doc, tag, 'tag-search-index.js'); + } + $(window).resize(function() { + $('.navPadding').css('padding-top', $('.fixedNav').css("height")); + }); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +function show(type) { + count = 0; + for (var key in data) { + var row = document.getElementById(key); + if ((data[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] + ""; + } + } +} + +function updateModuleFrame(pFrame, cFrame) { + top.packageFrame.location = pFrame; + top.classFrame.location = cFrame; +} diff --git a/docs/versions/3.0.1/javadoc/search.js b/docs/versions/3.0.1/javadoc/search.js new file mode 100644 index 000000000..9d3fb8122 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/search.js @@ -0,0 +1,329 @@ +/* + * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var noResult = {l: "No results found"}; +var catModules = "Modules"; +var catPackages = "Packages"; +var catTypes = "Types"; +var catMembers = "Members"; +var catSearchTags = "SearchTags"; +var highlight = "$&"; +var camelCaseRegexp = ""; +var secondaryMatcher = ""; +function getHighlightedText(item) { + var ccMatcher = new RegExp(camelCaseRegexp); + var label = item.replace(ccMatcher, highlight); + if (label === item) { + label = item.replace(secondaryMatcher, highlight); + } + return label; +} +function getURLPrefix(ui) { + var urlPrefix=""; + if (useModuleDirectories) { + var slash = "/"; + if (ui.item.category === catModules) { + return ui.item.l + slash; + } else if (ui.item.category === catPackages && ui.item.m) { + return ui.item.m + slash; + } else if ((ui.item.category === catTypes && ui.item.p) || ui.item.category === catMembers) { + $.each(packageSearchIndex, function(index, item) { + if (ui.item.p == item.l) { + urlPrefix = item.m + slash; + } + }); + return urlPrefix; + } else { + return urlPrefix; + } + } + return urlPrefix; +} +var watermark = 'Search'; +$(function() { + $("#search").val(''); + $("#search").prop("disabled", false); + $("#reset").prop("disabled", false); + $("#search").val(watermark).addClass('watermark'); + $("#search").blur(function() { + if ($(this).val().length == 0) { + $(this).val(watermark).addClass('watermark'); + } + }); + $("#search").on('click keydown', function() { + if ($(this).val() == watermark) { + $(this).val('').removeClass('watermark'); + } + }); + $("#reset").click(function() { + $("#search").val(''); + $("#search").focus(); + }); + $("#search").focus(); + $("#search")[0].setSelectionRange(0, 0); +}); +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)"); + }, + _renderMenu: function(ul, items) { + var rMenu = this, + currentCategory = ""; + $.each(items, function(index, item) { + var li; + if (item.l !== noResult.l && item.category !== currentCategory) { + ul.append("
  • " + item.category + "
    • "); + currentCategory = item.category; + } + li = rMenu._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", item.category + " : " + item.l); + li.attr("class", "resultItem"); + } else { + li.attr("aria-label", item.l); + li.attr("class", "resultItem"); + } + }); + }, + _renderItem: function(ul, item) { + var label = ""; + if (item.category === catModules) { + label = getHighlightedText(item.l); + } else if (item.category === catPackages) { + label = (item.m) + ? getHighlightedText(item.m + "/" + item.l) + : getHighlightedText(item.l); + } else if (item.category === catTypes) { + label = (item.p) + ? getHighlightedText(item.p + "." + item.l) + : getHighlightedText(item.l); + } else if (item.category === catMembers) { + label = getHighlightedText(item.p + "." + (item.c + "." + item.l)); + } else if (item.category === catSearchTags) { + label = getHighlightedText(item.l); + } else { + label = item.l; + } + $li = $("
  • ").appendTo(ul); + if (item.category === catSearchTags) { + if (item.d) { + $("").attr("href", "#") + .html(label + " (" + item.h + ")
    " + + item.d + "
    ") + .appendTo($li); + } else { + $("    ").attr("href", "#") + .html(label + " (" + item.h + ")") + .appendTo($li); + } + } else { + $("").attr("href", "#") + .html(label) + .appendTo($li); + } + return $li; + } +}); +$(function() { + $("#search").catcomplete({ + minLength: 1, + delay: 100, + source: function(request, response) { + var result = new Array(); + var presult = new Array(); + var tresult = new Array(); + var mresult = new Array(); + var tgresult = new Array(); + var secondaryresult = new Array(); + var displayCount = 0; + var exactMatcher = new RegExp("^" + $.ui.autocomplete.escapeRegex(request.term) + "$", "i"); + camelCaseRegexp = ($.ui.autocomplete.escapeRegex(request.term)).split(/(?=[A-Z])/).join("([a-z0-9_$]*?)"); + var camelCaseMatcher = new RegExp("^" + camelCaseRegexp); + secondaryMatcher = new RegExp($.ui.autocomplete.escapeRegex(request.term), "i"); + + // Return the nested innermost name from the specified object + function nestedName(e) { + return e.l.substring(e.l.lastIndexOf(".") + 1); + } + + function concatResults(a1, a2) { + a1 = a1.concat(a2); + a2.length = 0; + return a1; + } + + if (moduleSearchIndex) { + var mdleCount = 0; + $.each(moduleSearchIndex, function(index, item) { + item.category = catModules; + if (exactMatcher.test(item.l)) { + result.push(item); + mdleCount++; + } else if (camelCaseMatcher.test(item.l)) { + result.push(item); + } else if (secondaryMatcher.test(item.l)) { + secondaryresult.push(item); + } + }); + displayCount = mdleCount; + result = concatResults(result, secondaryresult); + } + if (packageSearchIndex) { + var pCount = 0; + var pkg = ""; + $.each(packageSearchIndex, function(index, item) { + item.category = catPackages; + pkg = (item.m) + ? (item.m + "/" + item.l) + : item.l; + if (exactMatcher.test(item.l)) { + presult.push(item); + pCount++; + } else if (camelCaseMatcher.test(pkg)) { + presult.push(item); + } else if (secondaryMatcher.test(pkg)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(presult, secondaryresult)); + displayCount = (pCount > displayCount) ? pCount : displayCount; + } + if (typeSearchIndex) { + var tCount = 0; + $.each(typeSearchIndex, function(index, item) { + item.category = catTypes; + var s = nestedName(item); + if (exactMatcher.test(s)) { + tresult.push(item); + tCount++; + } else if (camelCaseMatcher.test(s)) { + tresult.push(item); + } else if (secondaryMatcher.test(item.p + "." + item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(tresult, secondaryresult)); + displayCount = (tCount > displayCount) ? tCount : displayCount; + } + if (memberSearchIndex) { + var mCount = 0; + $.each(memberSearchIndex, function(index, item) { + item.category = catMembers; + var s = nestedName(item); + if (exactMatcher.test(s)) { + mresult.push(item); + mCount++; + } else if (camelCaseMatcher.test(s)) { + mresult.push(item); + } else if (secondaryMatcher.test(item.c + "." + item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(mresult, secondaryresult)); + displayCount = (mCount > displayCount) ? mCount : displayCount; + } + if (tagSearchIndex) { + var tgCount = 0; + $.each(tagSearchIndex, function(index, item) { + item.category = catSearchTags; + if (exactMatcher.test(item.l)) { + tgresult.push(item); + tgCount++; + } else if (secondaryMatcher.test(item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(tgresult, secondaryresult)); + displayCount = (tgCount > displayCount) ? tgCount : displayCount; + } + displayCount = (displayCount > 500) ? displayCount : 500; + var counter = function() { + var count = {Modules: 0, Packages: 0, Types: 0, Members: 0, SearchTags: 0}; + var f = function(item) { + count[item.category] += 1; + return (count[item.category] <= displayCount); + }; + return f; + }(); + response(result.filter(counter)); + }, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push(noResult); + } else { + $("#search").empty(); + } + }, + autoFocus: true, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.l !== noResult.l) { + var url = getURLPrefix(ui); + if (ui.item.category === catModules) { + if (useModuleDirectories) { + url += "module-summary.html"; + } else { + url = ui.item.l + "-summary.html"; + } + } else if (ui.item.category === catPackages) { + if (ui.item.url) { + url = ui.item.url; + } else { + url += ui.item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (ui.item.category === catTypes) { + if (ui.item.url) { + url = ui.item.url; + } else if (ui.item.p === "") { + url += ui.item.l + ".html"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.l + ".html"; + } + } else if (ui.item.category === catMembers) { + if (ui.item.p === "") { + url += ui.item.c + ".html" + "#"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#"; + } + if (ui.item.url) { + url += ui.item.url; + } else { + url += ui.item.l; + } + } else if (ui.item.category === catSearchTags) { + url += ui.item.u; + } + if (top !== window) { + parent.classFrame.location = pathtoroot + url; + } else { + window.location.href = pathtoroot + url; + } + } + } + }); +}); diff --git a/docs/versions/3.0.1/javadoc/serialized-form.html b/docs/versions/3.0.1/javadoc/serialized-form.html new file mode 100644 index 000000000..e1d497212 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/serialized-form.html @@ -0,0 +1,404 @@ + + + + + +Serialized Form (xenon 3.0.1 API) + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Serialized Form

    +
    +
    + +
    +
    + + + diff --git a/docs/versions/3.0.1/javadoc/stylesheet.css b/docs/versions/3.0.1/javadoc/stylesheet.css new file mode 100644 index 000000000..fa246765c --- /dev/null +++ b/docs/versions/3.0.1/javadoc/stylesheet.css @@ -0,0 +1,906 @@ +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:#bb7a2a; +} +a[name] { + color:#353833; +} +a[name]:before, a[name]:target, a[id]:before, a[id]:target { + content:""; + display:inline-block; + position:relative; + padding-top:129px; + margin-top:-129px; +} +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; +} + +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.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; +} +/* + * Styles for navigation bar. + */ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.navPadding { + padding-top: 107px; +} +.fixedNav { + position:fixed; + width:100%; + z-index:999; + background-color:#ffffff; +} +.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.navListSearch { + float:right; + margin:0 0 0 0; + padding:0; +} +ul.navListSearch li { + list-style:none; + float:right; + padding: 5px 6px; + text-transform:uppercase; +} +ul.navListSearch li label { + position:relative; + right:-16px; +} +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; +} +/* + * Styles for page header and footer. + */ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexNav { + position:relative; + font-size:12px; + background-color:#dee3e9; +} +.indexNav ul { + margin-top:0; + padding:5px; +} +.indexNav ul li { + display:inline; + list-style-type:none; + padding-right:10px; + text-transform:uppercase; +} +.indexNav 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; +} +/* + * Styles for headings. + */ +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; +} +/* + * Styles for page layout containers. + */ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer, +.allClassesContainer, .allPackagesContainer { + 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 Serif', Georgia, "Times New Roman", Times, serif; +} +.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; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +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; +} +/* + * Styles for tables. + */ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary, +.requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + width:100%; + border-spacing:0; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary, .requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption, +.requiresSummary caption, .packagesSummary caption, .providesSummary caption, .usesSummary 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, +.constantsSummary caption a:link, .deprecatedSummary caption a:link, +.requiresSummary caption a:link, .packagesSummary caption a:link, .providesSummary caption a:link, +.usesSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.requiresSummary caption a:hover, .packagesSummary caption a:hover, .providesSummary caption a:hover, +.usesSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.constantsSummary caption a:active, .deprecatedSummary caption a:active, +.requiresSummary caption a:active, .packagesSummary caption a:active, .providesSummary caption a:active, +.usesSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.constantsSummary caption a:visited, .deprecatedSummary caption a:visited, +.requiresSummary caption a:visited, .packagesSummary caption a:visited, .providesSummary caption a:visited, +.usesSummary caption a:visited { + color:#FFFFFF; +} +.useSummary caption a:link, .useSummary caption a:hover, .useSummary caption a:active, +.useSummary caption a:visited { + color:#1f389c; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span, +.requiresSummary caption span, .packagesSummary caption span, .providesSummary caption span, +.usesSummary 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, .packagesSummary caption span.activeTableTab span, +.overviewSummary caption span.activeTableTab span, .typeSummary 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, .packagesSummary caption span.tableTab span, +.overviewSummary caption span.tableTab span, .typeSummary 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, +.packagesSummary caption span.tableTab, .packagesSummary caption span.activeTableTab, +.overviewSummary caption span.tableTab, .overviewSummary caption span.activeTableTab, +.typeSummary caption span.tableTab, .typeSummary 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, +.requiresSummary .tabEnd, .packagesSummary .tabEnd, .providesSummary .tabEnd, .usesSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd, .packagesSummary .activeTableTab .tabEnd, +.overviewSummary .activeTableTab .tabEnd, .typeSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd, .packagesSummary .tableTab .tabEnd, +.overviewSummary .tableTab .tabEnd, .typeSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; +} +.rowColor th, .altColor th { + font-weight:normal; +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td, +.requiresSummary td, .packagesSummary td, .providesSummary td, .usesSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .useSummary th, +.constantsSummary th, .packagesSummary th, td.colFirst, td.colSecond, td.colLast, .useSummary td, +.constantsSummary td { + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .constantsSummary th, +.packagesSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + font-size:13px; +} +td.colSecond, th.colSecond, td.colLast, th.colConstructorName, th.colDeprecatedItemName, th.colLast { + font-size:13px; +} +.constantsSummary th, .packagesSummary th { + font-size:13px; +} +.providesSummary th.colFirst, .providesSummary th.colLast, .providesSummary td.colFirst, +.providesSummary td.colLast { + white-space:normal; + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.requiresSummary td.colFirst, .requiresSummary th.colFirst, +.packagesSummary td.colFirst, .packagesSummary td.colSecond, .packagesSummary th.colFirst, .packagesSummary th, +.usesSummary td.colFirst, .usesSummary th.colFirst, +.providesSummary td.colFirst, .providesSummary th.colFirst, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colSecond, .memberSummary th.colSecond, .memberSummary th.colConstructorName, +.typeSummary td.colFirst, .typeSummary th.colFirst { + vertical-align:top; +} +.packagesSummary th.colLast, .packagesSummary td.colLast { + white-space:normal; +} +td.colFirst a:link, td.colFirst a:visited, +td.colSecond a:link, td.colSecond a:visited, +th.colFirst a:link, th.colFirst a:visited, +th.colSecond a:link, th.colSecond a:visited, +th.colConstructorName a:link, th.colConstructorName a:visited, +th.colDeprecatedItemName a:link, th.colDeprecatedItemName a:visited, +.constantValuesContainer td a:link, .constantValuesContainer td a:visited, +.allClassesContainer td a:link, .allClassesContainer td a:visited, +.allPackagesContainer td a:link, .allPackagesContainer td a:visited { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor, .altColor th { + background-color:#FFFFFF; +} +.rowColor, .rowColor th { + background-color:#EEEEEF; +} +/* + * Styles for contents. + */ +.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; +} +/* + * Styles for formatting effect. + */ +.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, .implementationLabel, .memberNameLabel, .memberNameLink, +.moduleLabelInPackage, .moduleLabelInType, .overrideSpecifyLabel, .packageLabelInType, +.packageHierarchyLabel, .paramLabel, .returnLabel, .seeLabel, .simpleTagLabel, +.throwsLabel, .typeNameLabel, .typeNameLink, .searchTagLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} +.deprecationBlock { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.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; +} +/* + * Styles for IFRAME. + */ +.mainContainer { + margin:0 auto; + padding:0; + height:100%; + width:100%; + position:fixed; + top:0; + left:0; +} +.leftContainer { + height:100%; + position:fixed; + width:320px; +} +.leftTop { + position:relative; + float:left; + width:315px; + top:0; + left:0; + height:30%; + border-right:6px solid #ccc; + border-bottom:6px solid #ccc; +} +.leftBottom { + position:relative; + float:left; + width:315px; + bottom:0; + left:0; + height:70%; + border-right:6px solid #ccc; + border-top:1px solid #000; +} +.rightContainer { + position:absolute; + left:320px; + top:0; + bottom:0; + height:100%; + right:0; + border-left:1px solid #000; +} +.rightIframe { + margin:0; + padding:0; + height:100%; + right:30px; + width:100%; + overflow:visible; + margin-bottom:30px; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:#4D7A97; + color:#FFFFFF; +} +.resultItem { + font-size:13px; +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:scroll; + overflow-x:scroll; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:999999; +} +ul.ui-autocomplete li { + float:left; + clear:both; + width:100%; +} +.resultHighlight { + font-weight:bold; +} +#search { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + padding-left:20px; + position:relative; + right:-18px; +} +#reset { + background-color: rgb(255,255,255); + background-image:url('resources/x.png'); + background-position:center; + background-repeat:no-repeat; + background-size:12px; + border:0 none; + width:16px; + height:17px; + position:relative; + left:-4px; + top:-4px; + font-size:0px; +} +.watermark { + color:#545454; +} +.searchTagDescResult { + font-style:italic; + font-size:11px; +} +.searchTagHolderResult { + font-style:italic; + font-size:12px; +} +.searchTagResult:before, .searchTagResult:target { + color:red; +} +.moduleGraph span { + display:none; + position:absolute; +} +.moduleGraph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.methodSignature { + white-space:normal; +} + +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid black; +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid black; +} +table.striped { + border-collapse: collapse; + border: 1px solid black; +} +table.striped > thead { + background-color: #E3E3E3; +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid black; +} +table.striped > tbody > tr:nth-child(even) { + background-color: #EEE +} +table.striped > tbody > tr:nth-child(odd) { + background-color: #FFF +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid black; + border-right: 1px solid black; +} +table.striped > tbody > tr > th { + font-weight: normal; +} diff --git a/docs/versions/3.0.1/javadoc/type-search-index.js b/docs/versions/3.0.1/javadoc/type-search-index.js new file mode 100644 index 000000000..e05330b72 --- /dev/null +++ b/docs/versions/3.0.1/javadoc/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"p":"nl.esciencecenter.xenon","l":"AdaptorDescription"},{"l":"All Classes","url":"allclasses-index.html"},{"p":"nl.esciencecenter.xenon.filesystems","l":"AttributeNotSupportedException"},{"p":"nl.esciencecenter.xenon.credentials","l":"CertificateCredential"},{"p":"nl.esciencecenter.xenon.filesystems","l":"CopyCancelledException"},{"p":"nl.esciencecenter.xenon.filesystems","l":"CopyMode"},{"p":"nl.esciencecenter.xenon.filesystems","l":"CopyStatus"},{"p":"nl.esciencecenter.xenon.credentials","l":"Credential"},{"p":"nl.esciencecenter.xenon.credentials","l":"CredentialMap"},{"p":"nl.esciencecenter.xenon.utils","l":"DaemonThreadFactory"},{"p":"nl.esciencecenter.xenon.credentials","l":"DefaultCredential"},{"p":"nl.esciencecenter.xenon.filesystems","l":"DirectoryNotEmptyException"},{"p":"nl.esciencecenter.xenon.filesystems","l":"FileSystem"},{"p":"nl.esciencecenter.xenon.filesystems","l":"FileSystemAdaptorDescription"},{"p":"nl.esciencecenter.xenon.filesystems","l":"FileSystemClosedException"},{"p":"nl.esciencecenter.xenon.schedulers","l":"IncompleteJobDescriptionException"},{"p":"nl.esciencecenter.xenon.utils","l":"InputWriter"},{"p":"nl.esciencecenter.xenon","l":"InvalidCredentialException"},{"p":"nl.esciencecenter.xenon.schedulers","l":"InvalidJobDescriptionException"},{"p":"nl.esciencecenter.xenon","l":"InvalidLocationException"},{"p":"nl.esciencecenter.xenon.filesystems","l":"InvalidOptionsException"},{"p":"nl.esciencecenter.xenon.filesystems","l":"InvalidPathException"},{"p":"nl.esciencecenter.xenon","l":"InvalidPropertyException"},{"p":"nl.esciencecenter.xenon.filesystems","l":"InvalidResumeTargetException"},{"p":"nl.esciencecenter.xenon.utils","l":"JavaJobDescription"},{"p":"nl.esciencecenter.xenon.schedulers","l":"JobDescription"},{"p":"nl.esciencecenter.xenon.schedulers","l":"JobStatus"},{"p":"nl.esciencecenter.xenon.credentials","l":"KeytabCredential"},{"p":"nl.esciencecenter.xenon.utils","l":"LocalFileSystemUtils"},{"p":"nl.esciencecenter.xenon.filesystems","l":"NoSuchCopyException"},{"p":"nl.esciencecenter.xenon.schedulers","l":"NoSuchJobException"},{"p":"nl.esciencecenter.xenon.filesystems","l":"NoSuchPathException"},{"p":"nl.esciencecenter.xenon.schedulers","l":"NoSuchQueueException"},{"p":"nl.esciencecenter.xenon.utils","l":"OutputReader"},{"p":"nl.esciencecenter.xenon.credentials","l":"PasswordCredential"},{"p":"nl.esciencecenter.xenon.filesystems","l":"Path"},{"p":"nl.esciencecenter.xenon.filesystems","l":"PathAlreadyExistsException"},{"p":"nl.esciencecenter.xenon.filesystems","l":"PathAttributes"},{"p":"nl.esciencecenter.xenon.filesystems","l":"PosixFilePermission"},{"p":"nl.esciencecenter.xenon","l":"PropertyTypeException"},{"p":"nl.esciencecenter.xenon.schedulers","l":"QueueStatus"},{"p":"nl.esciencecenter.xenon.schedulers","l":"Scheduler"},{"p":"nl.esciencecenter.xenon.schedulers","l":"SchedulerAdaptorDescription"},{"p":"nl.esciencecenter.xenon.utils","l":"StreamForwarder"},{"p":"nl.esciencecenter.xenon.schedulers","l":"Streams"},{"p":"nl.esciencecenter.xenon","l":"XenonPropertyDescription.Type"},{"p":"nl.esciencecenter.xenon","l":"UnknownAdaptorException"},{"p":"nl.esciencecenter.xenon","l":"UnknownPropertyException"},{"p":"nl.esciencecenter.xenon.schedulers","l":"UnsupportedJobDescriptionException"},{"p":"nl.esciencecenter.xenon","l":"UnsupportedOperationException"},{"p":"nl.esciencecenter.xenon.credentials","l":"UserCredential"},{"p":"nl.esciencecenter.xenon","l":"XenonException"},{"p":"nl.esciencecenter.xenon","l":"XenonPropertyDescription"},{"p":"nl.esciencecenter.xenon","l":"XenonRuntimeException"}] \ No newline at end of file diff --git a/docs/versions/3.0.1/javadoc/type-search-index.zip b/docs/versions/3.0.1/javadoc/type-search-index.zip new file mode 100644 index 000000000..bc5473e59 Binary files /dev/null and b/docs/versions/3.0.1/javadoc/type-search-index.zip differ