Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ksclarke/vertx-pairtree
A file system or S3 backed Pairtree library for the Vert.x tool-kit.
https://github.com/ksclarke/vertx-pairtree
code4lib pairtree vertx
Last synced: about 2 months ago
JSON representation
A file system or S3 backed Pairtree library for the Vert.x tool-kit.
- Host: GitHub
- URL: https://github.com/ksclarke/vertx-pairtree
- Owner: ksclarke
- License: bsd-3-clause
- Created: 2016-08-03T21:24:05.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-07-15T21:07:11.000Z (over 2 years ago)
- Last Synced: 2024-11-14T17:11:39.346Z (2 months ago)
- Topics: code4lib, pairtree, vertx
- Language: Java
- Size: 973 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# vertx-pairtree [](https://travis-ci.org/ksclarke/vertx-pairtree) [](https://www.codacy.com/app/ksclarke/vertx-pairtree?utm_source=github.com&utm_medium=referral&utm_content=ksclarke/vertx-pairtree&utm_campaign=Badge_Coverage) [](https://snyk.io/test/github/ksclarke/vertx-pairtree?targetFile=pom.xml) [](http://mvnrepository.com/artifact/info.freelibrary/vertx-pairtree) [](http://projects.freelibrary.info/vertx-pairtree/javadocs.html)
A file system or S3 backed [Pairtree](https://wiki.ucop.edu/display/Curation/PairTree) library for use with the [Vert.x](http://vertx.io/) tool-kit. To use it, include its Jar file in your project's classpath.
### Getting Started
To check out and build the project, type on the command line:
git clone https://github.com/ksclarke/vertx-pairtree.git
cd vertx-pairtree
mvn install
This will run the build and the unit tests for the file system back end. Right now, the only tests for the S3 back-end are integration tests. To run a build with them, you will need to put the following properties in your [settings.xml file](https://maven.apache.org/settings.html) and run the build with the `s3it` profile:
YOUR_S3_BUCKET_NAME
YOUR_ACCESS_KEY
YOUR_SECRET_KEY
Or, you can supply the required properties on the command line (with the same `s3it` profile) when you build the project:
mvn install -Ps3it -Dvertx.s3.bucket=YOUR_S3_BUCKET_NAME \
-Dvertx.s3.access_key=YOUR_ACCESS_KEY \
-Dvertx.s3.secret_key=YOUR_SECRET_KEY
The YOUR_S3_BUCKET_NAME, YOUR_ACCESS_KEY and YOUR_SECRET_KEY values obviously need to be replaced with real values. Within AWS' Identity and Access Management service you can configure a user that has permission to perform actions on the S3 bucket you've created for this purpose. For an example of the IAM inline user policy for an S3 bucket, consult the [example JSON file](https://github.com/ksclarke/freelib-utils/blob/master/src/test/resources/sample-iam-policy.json) in the project's `src/test/resources` directory.
You can name the S3 bucket whatever you want (and change its system property to match), but make sure the bucket is only used for these integration tests. The tests will delete all the contents of the bucket as a part of the test tear down. When these tests are run in Travis, a JDK name is appended onto the S3 bucket name so that the tests can be run concurrently (e.g. YOUR_S3_BUCKET_NAME-openjdk11). These buckets also need to be created ahead of time in order for the tests to pass.
If you want to put your test S3 bucket in a region other than the standard us-east-1, you will also need to supply a `vertx.s3.region` argument. For example:
mvn install -Ps3it -Dvertx.s3.bucket=YOUR_S3_BUCKET_NAME \
-Dvertx.s3.access_key=YOUR_ACCESS_KEY \
-Dvertx.s3.secret_key=YOUR_SECRET_KEY \
-Dvertx.s3.region="us-west-2"
It can also be supplied through your settings.xml file. At this point, only regions that support signature version 2 authentication are supported. To see the valid S3 region endpoints, consult [AWS' documentation](http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region).
Lastly, if you don't want to build it yourself, the library can be downloaded from the Maven central repository by putting the following in your project's [pom.xml file](https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html):
info.freelibrary
vertx-pairtree
${vertx.pairtree.version}
### Acknowledgments
In addition to all the dependencies listed in the pom.xml file, this project incorporates a [Pairtree implementation](https://github.com/LibraryOfCongress/pairtree) from the Library of Congress. It has been modified from its original version.
### Contact
If you have questions about vertx-pairtree feel free to ask or, if you encounter a problem, please feel free to [open a ticket](https://github.com/ksclarke/vertx-pairtree/issues "GitHub Issue Queue") in the project's issues queue.