ViPR Services Java SDK

NOTE: The ViPR S3 client is deprecated and has been replaced with the ECS Java Object Client: ECS Object Client SDK for Java

GitHub: Home · EMCECS/ecs-object-client-java Wiki · GitHub

The Java SDK for ViPR Services provides libraries, documentation, and sample code for application development using ViPR object storage.  The SDK is compatible with Java 7 (1.7.0) and up.

Release Notes


Version 2.0.3

  • S3: Fixed SDK-72: added AWS escaping to resource path when signing requests
  • Atmos (version 2.2.2)
    • added objectExists() method
    • added wsChecksum and serverChecksum properties to ObjectMetadata
    • fixed bug where client was not properly encoding/decoding the plus character in paths and metadata


Version 2.0.2

  • S3: Fixed SDK-71: listBuckets always tries to use vhost request


Version 2.0.1

  • S3: Fixed SDK-68: Signature failures for objects with a slash in the key


Version 2.0

  • Last release to support Java 6
  • S3
    • Added list-data-nodes call (?endpoint)
    • New Smart Client feature.


Version 1.1.1


Version 1.1

  • Atmos:
    • Better proxy support (Apache client now supports "http.nonProxyHosts")
    • Fixed bug with ViPR object IDs being longer than 44 characters
    • Updated Jersey dep and custom client handler to 1.18
  • S3:
    • Updated AWS dep to 1.6.11
    • Added ViPR 1.1 enhancements
      • create-bucket fs-access option (HDFS)
      • preserve-ingest-paths option for bucket file access (only for ingested buckets)


Version 1.0

Supported in this release:

  • S3
    • Existing AWS library functionality
    • ViPR file access mode functionality
    • ViPR object append/update operations
    • ViPR object namespace support
  • Atmos
    • Atmos 2.0 functionality with some restrictions
    • ViPR create subtenant call




Full SDK

The full SDK provides libraries, source, and documentation in .ZIP format.

Latest releases:



Artifacts for the Atmos and S3 clients are published in Maven Central.  If you have a Maven project, you can import them as a dependency.


To import the ViPR S3 Client, add the following dependency to your project:



To import the ViPR Atmos Client, add the following dependency:



Note: the Atmos client requires an additional unpublished jar (security-1.1.jar).  If you're using maven, the following command will install the jar in your local reposiotory:


mvn org.apache.maven.plugins:maven-install-plugin:2.5.1:install-file -Dfile=security-1.1.jar


The Maven central repository also has dependency includes for other popular dependency management systems like Ivy and Grails.  See the page for the s3-client or the atmos-client.


API Documentation


API docs are hosted in our GitHub site here:





Source Code


Source code is available for the SDK, hosted at the following GitHub repository:


Quick Start