https://github.com/tritondatacenter/java-manta
Java Manta Client SDK
https://github.com/tritondatacenter/java-manta
java joyent jvm manta object-store smartdatacenter triton
Last synced: about 2 months ago
JSON representation
Java Manta Client SDK
- Host: GitHub
- URL: https://github.com/tritondatacenter/java-manta
- Owner: TritonDataCenter
- License: mpl-2.0
- Created: 2012-12-20T19:29:31.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2020-09-30T18:59:41.000Z (over 4 years ago)
- Last Synced: 2025-03-27T13:11:09.331Z (2 months ago)
- Topics: java, joyent, jvm, manta, object-store, smartdatacenter, triton
- Language: Java
- Homepage:
- Size: 19.3 MB
- Stars: 16
- Watchers: 45
- Forks: 27
- Open Issues: 45
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://travis-ci.org/joyent/java-manta)
# Java Manta Client SDK
[java-manta](http://joyent.github.com/java-manta) is a community-maintained Java
SDK for interacting with Joyent's Manta system.
## Projects Using the Java Manta Client SDK
* [Apache Commons VFS Manta Provider (Virtual File System)](https://github.com/joyent/commons-vfs-manta)
* [Hadoop Filesystem Driver for Manta](https://github.com/joyent/hadoop-manta)
* [Manta Logback Rollover](https://github.com/dekobon/manta-logback-rollover)
* [COSBench Adaptor for Manta - Object Store Benchmarks](https://github.com/joyent/cosbench-manta)
* [Manta Monitor](https://github.com/joyent/manta-monitor)
* [Java Manta Test Harness](https://github.com/joyent/java-manta-test-harness)
## Installation
[Java 1.8](http://www.oracle.com/technetwork/java/javase/downloads/index.html) is required for SDK compilation.
It effectively supports both [Java 8 and Java 11](https://www.oracle.com/technetwork/java/javase/downloads/index.html)
in *application usage*. The main client module can be installed by adding the following dependency using
[Maven 3.1.x](https://maven.apache.org/):
```
com.joyent.manta
java-manta-client
LATEST
```
and the unshaded module can be installed by adding the following dependency using [Maven 3.1.x](https://maven.apache.org/):
```
com.joyent.manta
java-manta-client-unshaded
LATEST
```
Please refer to the [installation documentation](/USAGE.md) for more details about the following topics:
* [192-bit and 256-bit AES encryption requiring Java Cryptography Extensions](/USAGE.md#unlimited-encryption-requirements)
* [PKCS#11 configuration for faster encryption using libnss](/USAGE.md#enabling-libnss-support-via-pkcs11)
* [Native implementation of MD5 calculations for faster digest operations](/USAGE.md#enabling-native-fastmd5-support)
## Configuration
Configuration can be done through system properties or environment variables.
Listed below are the most commonly used configuration options:
| System Property | Environment Variable | Default |
|------------------------------------|--------------------------------|--------------------------------------|
| manta.url | MANTA_URL | https://us-east.manta.joyent.com:443 |
| manta.user | MANTA_USER | |
| manta.key_id | MANTA_KEY_ID | |
| manta.key_path | MANTA_KEY_PATH | $HOME/.ssh/id_rsa (if exists) |
* `manta.url` ( **MANTA_URL** )
The URL of the manta service endpoint to test against
* `manta.user` ( **MANTA_USER** )
The account name used to access the manta service. If accessing via a [subuser](https://docs.joyent.com/public-cloud/rbac/users),
you will specify the account name as "user/subuser".
* `manta.key_id`: ( **MANTA_KEY_ID**)
The fingerprint for the public key used to access the manta service. Can be obtained using `ssh-keygen -l -f ${MANTA_KEY_PATH} -E md5 | cut -d' ' -f 2`
* `manta.key_path` ( **MANTA_KEY_PATH**)
The name of the file that will be loaded for the account used to access the manta service.
Please refer to the [configuration documentation](/USAGE.md#configuration) for example code and the full
list of configuration options which include retry and performance tuning in addition to encryption and authentication
parameters.
## Usage
You'll need a manta login, an associated key, and its corresponding key
fingerprint.
You will then create or use an implementation of `ConfigContext` to set up
your configuration. Once you have an instance of your configuration class,
you will then construct a `MantaClient` instance. The `MantaClient` class
is intended to be used per Manta account. It is thread-safe and you should
share one instance across multiple threads.
For detailed usage instructions consult the provided JavaDoc and examples. The
JavaDoc can also be browsed online at [javadoc.io](https://javadoc.io/doc/com.joyent.manta/java-manta-client/)
### General Examples
* [Get request and client setup](/java-manta-examples/src/main/java/SimpleClient.java)
* [Multipart upload](/java-manta-examples/src/main/java/ServerMultipart.java)
* [Client-side Encryption](/java-manta-examples/src/main/java/SimpleClientEncryption.java)
### Job Examples
Jobs can be created directly with the `MantaClient` class or they can be created
using the `MantaJobBuilder` class. `MantaJobBuilder` provides a fluent interface
that allows for an easier API for job creation and it provides a number of
useful functions for common use cases.
* [Jobs using MantaClient](/java-manta-examples/src/main/java/JobsWithMantaClient.java)
* [Jobs using MantaJobBuilder](/java-manta-examples/src/main/java/JobsWithMantaJobBuilder.java)
For more examples, check the included [examples module](/java-manta-examples) and the
[integration test module](/java-manta-it/src/test/java/com/joyent/manta/client).
## FAQs
Known edge cases and other topics are covered in [the FAQ](/FAQ.md).
## Contributions
Contributions are welcome! Please read the [CONTRIBUTING.md](/CONTRIBUTING.md) document for details
on getting started.
## Developing
There are portions of the SDK that are somewhat complex or fiddly. Please read the [DEVELOPING.md](/DEVELOPING.md)
document for details, before developing the Java SDK.
### Testing
Contributing developers are strongly encouraged to add unit-tests and integration-tests. Refer to the [testing documentation](/TESTING.md)
for information on full test suite requirements.
### Releasing
Please refer to the [release documentation](/RELEASING.md).
### Bugs
See .
## License
Java Manta is licensed under the MPLv2. Please see the [LICENSE.txt](/LICENSE.txt)
file for more details. The license was changed from the MIT license to the MPLv2
license starting at version 2.3.0.
### Credits
We are grateful for the functionality provided by the libraries that this project
depends on. Without them, we would be building everything from scratch. A thank you
goes out to:
* [The Apache Commons Project](https://commons.apache.org/)
* [The Apache HTTP Components Project](http://hc.apache.org/)
* [The FastXML Project](https://github.com/FasterXML)
* [The Legion of the Bouncy Castle Project](https://www.bouncycastle.org/)
* [The SLF4J Project](http://www.slf4j.org/)
* [The JNAGMP Project](https://github.com/square/jna-gmp)
* [The TestNG Project](http://testng.org/doc/index.html)
* [The Mockito Project](http://site.mockito.org/)
* [Timothy W Macinta's FastMD5 Project](http://twmacinta.com/myjava/fast_md5.php)
* [Remko Popma's picocli Project](https://github.com/remkop/picocli)