porklock

A command-line tool for interacting with iRODS.

License	BSD
Categories	Ant Build Tools
GroupId	org.iplantc
ArtifactId	porklock
Last Version	1.2.2
Release Date	Feb 13, 2014
Type	jar
Description	porklock A command-line tool for interacting with iRODS.
Project URL	http://www.iplantcollaborative.org
Source Code Management	https://github.com/iPlantCollaborativeOpenSource/filetool

Download porklock

Filename	Size
porklock-1.2.2.pom
porklock-1.2.2.jar	1 MB
porklock-1.2.2-sources.jar	13 KB
porklock-1.2.2-javadoc.jar	13 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.iplantc/porklock/ -->
<dependency>
    <groupId>org.iplantc</groupId>
    <artifactId>porklock</artifactId>
    <version>1.2.2</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.iplantc/porklock/
implementation 'org.iplantc:porklock:1.2.2'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.iplantc/porklock/
implementation ("org.iplantc:porklock:1.2.2")

Apache Buildr

'org.iplantc:porklock:jar:1.2.2'

Apache Ivy

<dependency org="org.iplantc" name="porklock" rev="1.2.2">
  <artifact name="porklock" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.iplantc', module='porklock', version='1.2.2')
)

Scala SBT

libraryDependencies += "org.iplantc" % "porklock" % "1.2.2"

Leiningen

[org.iplantc/porklock "1.2.2"]

Dependencies

compile (10)

Group / Artifact	Type	Version
org.clojure : clojure	jar	1.5.1
org.clojure : tools.logging	jar	0.2.6
org.iplantc : clojure-commons	jar	1.4.8
org.clojure : tools.cli	jar	0.2.1
commons-io : commons-io	jar	2.2
slingshot » slingshot	jar	0.10.3
com.cemerick » url	jar	0.0.7
com.novemberain » welle	jar	1.4.0
cheshire » cheshire	jar	5.1.1
org.iplantc : clj-jargon	jar	0.4.2

test (2)

Group / Artifact	Type	Version
org.clojure : tools.nrepl	jar	0.2.3
clojure-complete » clojure-complete	jar	0.2.3

Project Modules

There are no modules declared in this project.

porklock

This tool is responsible for transferring files from an analysis directory into iRODS. It is usually called as part of a Condor DAG.

CONFIGURATION

Make sure that the .irodsEnv and .irodsA files are located in ~/.irods/ for the system-level user that will be running the filetool.

Make sure that the imkdir, ils, and iput commands are available in a directory that is on the system's PATH.

filetool uses the .irodsEnv and .irodsA files to configure itself and the i-commands that it runs. It will search the home directory of the user running the tool for the .irods/ directory and will use the .irodsEnv and .irodsA file contained within. Additionally, it will search the user's PATH for the imkdir, ils, and iput commands. It will use the first matches that it encounters.

No additional configuration files are needed.

COMMAND LINE OPTIONS

Note: If you don't use the '--exclude' or '--include' options, then every file in '--source' will be transferred into '--destination'. The operation is recursive.

--destination

The path to the directory on the iRODS server that the files should be placed in. This flag is required.

--exclude

A list of files to exclude from the transfer. By default, the list is delimited by commas, but you can set your own delimiter with the '-exclude-delimiter' option. Note, if you specify a file that doesn't exist you will NOT get an error message. This is intentional. It allows scripts to define a default set of excluded files without worrying about errors if the excluded file does not exist. This flag is optional.

--exclude-delimiter

The delimiter used in the '-exclude' option. It defaults to ','. This flag is optional.

--include

A whitelist of files to transfer. If this option is used, then any files that aren't included in this list will NOT be transferred into iRODS. Also, if a file is included in both the '-include' and '-exclude' lists, then it will NOT be transferred into iRODS. In other words, the '-exclude' option overrides the '-include' option. This flag is optional.

--include-delimiter

The delimiter used in the '-include' option. It defaults to ','. This flag is optional.

--single-threaded

This option will cause the 'iput' commands that are executed by filetool to run in single-threaded mode. In other words, it adds the '-N 0' flag to the options passed to the 'iput' command. This does NOT alter change the threadedness of filetool itself. This flag is optional.

--source

The path to the directory on the local system that contains files to be transferred into iRODS. Only one directory can be specified at a time. This flag is required.

iPlant Collaborative Open Source

This is an old github organization. The new organization is github.com/cyverse

Versions

Version
1.2.2 Feb 13, 2014