https://github.com/sangupta/urn
Object storage library
https://github.com/sangupta/urn
Last synced: 11 months ago
JSON representation
Object storage library
- Host: GitHub
- URL: https://github.com/sangupta/urn
- Owner: sangupta
- License: apache-2.0
- Created: 2016-02-03T05:10:15.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-07-15T21:07:06.000Z (over 3 years ago)
- Last Synced: 2025-01-02T11:12:29.060Z (about 1 year ago)
- Language: Java
- Size: 54.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# urn
[](https://travis-ci.org/sangupta/urn)
[](https://coveralls.io/github/sangupta/urn?branch=master)
[](https://maven-badges.herokuapp.com/maven-central/com.sangupta/urn)
`urn` is a Java library that helps integrate with different object stores via a simple API, allowing you to change
the provider at runtime without changing the code.
Currently available object store providers:
* In-memory
* Flat-file on disk
* Redis
* MongoDB - collection based
* MongoDB - GridFS based
Ones in the pipeline:
* Amazon S3
* SeaWeedFS
* LevelDB
* RocksDB
* SQlite
## Features
* Ability for time-based eviction of each individual asset (depends on provider)
* Metadata storage with object like MIME type
* Custom name that can be set, different from the unique key
## Feature Roadmap
* A simple server that can serve the raw stream using the key
## Usage
Using `urn` is pretty straight-forward:
```java
UrnStorageService service = new RedisUrnStorageServiceImpl();
String objectKey = "myObject-123";
// save a new object
service.saveObject(objectKey, getRandomBytes());
// check if the object is saved or not
service.existsObject(objectKey); // returns true
// retrieve data
service.getObjectBytes(objectKey); // returns the byte[]
// delete object
service.remove(objectKey);
service.existsObject(objectKey); // returns false
```
## Versioning
For transparency and insight into our release cycle, and for striving to maintain backward compatibility,
`urn` will be maintained under the Semantic Versioning guidelines as much as possible.
Releases will be numbered with the follow format:
`..`
And constructed with the following guidelines:
* Breaking backward compatibility bumps the major
* New additions without breaking backward compatibility bumps the minor
* Bug fixes and misc changes bump the patch
For more information on SemVer, please visit http://semver.org/.
## License
```
urn - Object storage library
Copyright (c) 2016, Sandeep Gupta
http://sangupta.com/projects/urn
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```