├── .gitignore ├── src └── main │ └── java │ └── com │ └── github │ └── aleksandarskrbic │ └── rocks4j │ ├── mapper │ ├── MapperFactory.java │ ├── exception │ │ ├── SerDeException.java │ │ ├── SerializationException.java │ │ └── DeserializationException.java │ ├── Mapper.java │ └── JsonMapper.java │ ├── core │ ├── exception │ │ ├── RocksIOException.java │ │ ├── SaveFailedException.java │ │ ├── FindFailedException.java │ │ ├── DeleteFailedException.java │ │ └── DeleteAllFailedException.java │ ├── RocksDBConfiguration.java │ ├── RocksDBConnection.java │ ├── KeyValueStore.java │ ├── AsyncKeyValueStore.java │ ├── AsyncKVStore.java │ └── KVStore.java │ └── Test.java ├── README.md ├── pom.xml └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .classpath 2 | .project 3 | .settings/ 4 | 5 | .idea/ 6 | *.iml 7 | *.iws 8 | 9 | .DS_Store 10 | 11 | log/ 12 | target/ 13 | 14 | src/main/java/resources/data/* 15 | -------------------------------------------------------------------------------- /src/main/java/com/github/aleksandarskrbic/rocks4j/mapper/MapperFactory.java: -------------------------------------------------------------------------------- 1 | package com.github.aleksandarskrbic.rocks4j.mapper; 2 | 3 | public interface MapperFactory { 4 | 5 | static JsonMapper createFor(final Class type) { 6 | return new JsonMapper<>(type); 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /src/main/java/com/github/aleksandarskrbic/rocks4j/core/exception/RocksIOException.java: -------------------------------------------------------------------------------- 1 | package com.github.aleksandarskrbic.rocks4j.core.exception; 2 | 3 | /** 4 | * Base class for exceptions related to IO operations against Key-Value Store. 5 | */ 6 | public abstract class RocksIOException extends Exception { 7 | 8 | public RocksIOException(final String message) { 9 | super(message); 10 | } 11 | 12 | public RocksIOException( 13 | final String message, 14 | final Throwable throwable 15 | ) { 16 | super(message, throwable); 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /src/main/java/com/github/aleksandarskrbic/rocks4j/mapper/exception/SerDeException.java: -------------------------------------------------------------------------------- 1 | package com.github.aleksandarskrbic.rocks4j.mapper.exception; 2 | 3 | import java.io.IOException; 4 | 5 | /** 6 | * Base class for serialization/deserialization exceptions. 7 | */ 8 | public abstract class SerDeException extends IOException { 9 | 10 | public SerDeException(final String message) { 11 | super(message); 12 | } 13 | 14 | public SerDeException( 15 | final String message, 16 | final Throwable throwable 17 | ) { 18 | super(message, throwable); 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /src/main/java/com/github/aleksandarskrbic/rocks4j/core/exception/SaveFailedException.java: -------------------------------------------------------------------------------- 1 | package com.github.aleksandarskrbic.rocks4j.core.exception; 2 | 3 | /** 4 | * {@link SaveFailedException} is thrown when there is a problem with saving an entity to a repository. 5 | */ 6 | public final class SaveFailedException extends RocksIOException { 7 | 8 | public SaveFailedException(final String message) { 9 | super(message); 10 | } 11 | 12 | public SaveFailedException( 13 | final String message, 14 | final Throwable throwable 15 | ) { 16 | super(message, throwable); 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /src/main/java/com/github/aleksandarskrbic/rocks4j/mapper/exception/SerializationException.java: -------------------------------------------------------------------------------- 1 | package com.github.aleksandarskrbic.rocks4j.mapper.exception; 2 | 3 | /** 4 | * {@link SerializationException} is thrown when there is a problem with serialization. 5 | */ 6 | public final class SerializationException extends SerDeException { 7 | 8 | public SerializationException(final String message) { 9 | super(message); 10 | } 11 | 12 | public SerializationException( 13 | final String message, 14 | final Throwable throwable 15 | ) { 16 | super(message, throwable); 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /src/main/java/com/github/aleksandarskrbic/rocks4j/core/exception/FindFailedException.java: -------------------------------------------------------------------------------- 1 | package com.github.aleksandarskrbic.rocks4j.core.exception; 2 | 3 | /** 4 | * {@link FindFailedException} is thrown when there is a problem with retrieving an entity from a repository. 5 | */ 6 | public final class FindFailedException extends RocksIOException { 7 | 8 | public FindFailedException(final String message) { 9 | super(message); 10 | } 11 | 12 | public FindFailedException( 13 | final String message, 14 | final Throwable throwable 15 | ) { 16 | super(message, throwable); 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /src/main/java/com/github/aleksandarskrbic/rocks4j/mapper/exception/DeserializationException.java: -------------------------------------------------------------------------------- 1 | package com.github.aleksandarskrbic.rocks4j.mapper.exception; 2 | 3 | /** 4 | * {@link DeserializationException} is thrown when there is a problem with deserialization. 5 | */ 6 | public final class DeserializationException extends SerDeException { 7 | 8 | public DeserializationException(final String message) { 9 | super(message); 10 | } 11 | 12 | public DeserializationException( 13 | final String message, 14 | final Throwable throwable 15 | ) { 16 | super(message, throwable); 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /src/main/java/com/github/aleksandarskrbic/rocks4j/core/exception/DeleteFailedException.java: -------------------------------------------------------------------------------- 1 | package com.github.aleksandarskrbic.rocks4j.core.exception; 2 | 3 | /** 4 | * {@link DeleteFailedException} is thrown when there is a problem with deleting an entity from a repository. 5 | */ 6 | public final class DeleteFailedException extends RocksIOException { 7 | 8 | public DeleteFailedException(final String message) { 9 | super(message); 10 | } 11 | 12 | public DeleteFailedException( 13 | final String message, 14 | final Throwable throwable 15 | ) { 16 | super(message, throwable); 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /src/main/java/com/github/aleksandarskrbic/rocks4j/core/exception/DeleteAllFailedException.java: -------------------------------------------------------------------------------- 1 | package com.github.aleksandarskrbic.rocks4j.core.exception; 2 | 3 | /** 4 | * {@link DeleteAllFailedException} is thrown when there is a problem with deleting all entities from a repository. 5 | */ 6 | public final class DeleteAllFailedException extends RocksIOException { 7 | 8 | public DeleteAllFailedException(final String message) { 9 | super(message); 10 | } 11 | 12 | public DeleteAllFailedException( 13 | final String message, 14 | final Throwable throwable 15 | ) { 16 | super(message, throwable); 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /src/main/java/com/github/aleksandarskrbic/rocks4j/mapper/Mapper.java: -------------------------------------------------------------------------------- 1 | package com.github.aleksandarskrbic.rocks4j.mapper; 2 | 3 | import com.github.aleksandarskrbic.rocks4j.mapper.exception.DeserializationException; 4 | import com.github.aleksandarskrbic.rocks4j.mapper.exception.SerializationException; 5 | 6 | /** 7 | * Interface that defines methods for mapping to bytes. 8 | * 9 | * @param Value type that should be serialized or deserialized. 10 | */ 11 | public interface Mapper { 12 | 13 | /** 14 | * Try to serialize entity to byte array. 15 | * 16 | * @param t entity that should be serialized to byte array. 17 | * @return byte array of serialized entity. 18 | * @throws SerializationException when it's not possible to serialize entity. 19 | */ 20 | byte[] serialize(T t) throws SerializationException; 21 | 22 | /** 23 | * Try to deserialize byte array to entity. 24 | * 25 | * @param bytes that should be deserialized to entity. 26 | * @return deserialized entity 27 | * @throws DeserializationException when it's not possible to deserialize entity. 28 | */ 29 | T deserialize(byte[] bytes) throws DeserializationException; 30 | } 31 | -------------------------------------------------------------------------------- /src/main/java/com/github/aleksandarskrbic/rocks4j/core/RocksDBConfiguration.java: -------------------------------------------------------------------------------- 1 | package com.github.aleksandarskrbic.rocks4j.core; 2 | 3 | /** 4 | * Configuration class for RocksDB. 5 | * Path is path to files where data will be stored. 6 | * Name is the name of repository. 7 | */ 8 | public final class RocksDBConfiguration { 9 | 10 | protected final String path; 11 | protected final String name; 12 | protected int threadCount = 5; 13 | 14 | public RocksDBConfiguration( 15 | final String path, 16 | final String name 17 | ) { 18 | this.path = path; 19 | this.name = name; 20 | } 21 | 22 | public RocksDBConfiguration( 23 | final String path, 24 | final String name, 25 | final int threadCount 26 | ) { 27 | this.path = path; 28 | this.name = name; 29 | this.threadCount = threadCount; 30 | } 31 | 32 | public String path() { 33 | return path; 34 | } 35 | 36 | public String name() { 37 | return name; 38 | } 39 | 40 | public int threadCount() { 41 | return threadCount; 42 | } 43 | 44 | public String url() { 45 | return path + "/" + name; 46 | } 47 | } 48 | -------------------------------------------------------------------------------- /src/main/java/com/github/aleksandarskrbic/rocks4j/core/RocksDBConnection.java: -------------------------------------------------------------------------------- 1 | package com.github.aleksandarskrbic.rocks4j.core; 2 | 3 | import java.nio.file.Path; 4 | import java.nio.file.Paths; 5 | 6 | import org.rocksdb.Options; 7 | import org.rocksdb.RocksDB; 8 | import org.slf4j.Logger; 9 | import org.slf4j.LoggerFactory; 10 | import static java.nio.file.Files.createDirectories; 11 | 12 | /** 13 | * Class responsible for communication with RocksDB. 14 | */ 15 | public abstract class RocksDBConnection { 16 | 17 | private static final Logger LOGGER = LoggerFactory.getLogger(RocksDBConnection.class); 18 | 19 | protected RocksDB rocksDB; 20 | 21 | public RocksDBConnection(final RocksDBConfiguration configuration) { 22 | RocksDB.loadLibrary(); 23 | 24 | try { 25 | final Options options = new Options().setCreateIfMissing(true); 26 | final String root = System.getProperty("user.dir"); 27 | final String rocksDirectory = root + configuration.url(); 28 | final Path path = Paths.get(rocksDirectory); 29 | createDirectories(path); 30 | rocksDB = RocksDB.open(options, path.toString()); 31 | } catch (final Exception exception) { 32 | LOGGER.error("Exception occurred during RocksDB initialization. Shutting down application..."); 33 | System.exit(1); 34 | } 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /src/main/java/com/github/aleksandarskrbic/rocks4j/mapper/JsonMapper.java: -------------------------------------------------------------------------------- 1 | 2 | package com.github.aleksandarskrbic.rocks4j.mapper; 3 | 4 | import java.io.IOException; 5 | import com.fasterxml.jackson.core.JsonProcessingException; 6 | import com.fasterxml.jackson.databind.ObjectMapper; 7 | import com.github.aleksandarskrbic.rocks4j.mapper.exception.DeserializationException; 8 | import com.github.aleksandarskrbic.rocks4j.mapper.exception.SerializationException; 9 | 10 | /** 11 | * RocksDBMapper provides methods for serialization and deserialization using JSON. 12 | * 13 | * @param Value type that should be serialized or deserialized. 14 | */ 15 | public final class JsonMapper implements Mapper { 16 | 17 | private final Class type; 18 | private final ObjectMapper mapper; 19 | 20 | public JsonMapper(final Class type) { 21 | this.type = type; 22 | this.mapper = new ObjectMapper(); 23 | } 24 | 25 | @Override 26 | public byte[] serialize(final T t) throws SerializationException { 27 | try { 28 | return mapper.writeValueAsBytes(t); 29 | } catch (final JsonProcessingException exception) { 30 | throw new SerializationException(exception.getMessage(), exception); 31 | } 32 | } 33 | 34 | @Override 35 | public T deserialize(final byte[] bytes) throws DeserializationException { 36 | try { 37 | return mapper.readValue(bytes, type); 38 | } catch (final IOException exception) { 39 | throw new DeserializationException(exception.getMessage(), exception); 40 | } 41 | } 42 | } -------------------------------------------------------------------------------- /src/main/java/com/github/aleksandarskrbic/rocks4j/core/KeyValueStore.java: -------------------------------------------------------------------------------- 1 | package com.github.aleksandarskrbic.rocks4j.core; 2 | 3 | import java.util.Collection; 4 | import java.util.Optional; 5 | import com.github.aleksandarskrbic.rocks4j.core.exception.DeleteAllFailedException; 6 | import com.github.aleksandarskrbic.rocks4j.core.exception.DeleteFailedException; 7 | import com.github.aleksandarskrbic.rocks4j.core.exception.FindFailedException; 8 | import com.github.aleksandarskrbic.rocks4j.core.exception.SaveFailedException; 9 | import com.github.aleksandarskrbic.rocks4j.mapper.exception.DeserializationException; 10 | import com.github.aleksandarskrbic.rocks4j.mapper.exception.SerDeException; 11 | import com.github.aleksandarskrbic.rocks4j.mapper.exception.SerializationException; 12 | 13 | /** 14 | * Interface that defines operations against Key-Value Store. 15 | * 16 | * @param Key type. 17 | * @param Value type. 18 | */ 19 | public interface KeyValueStore { 20 | 21 | /** 22 | * Inserts key-value pair into RocksDB. 23 | * 24 | * @param key of value. 25 | * @param value that should be persisted. 26 | * @throws SerializationException when it's not possible to serialize entity. 27 | * @throws SaveFailedException when it's not possible to persist entity. 28 | */ 29 | void save(K key, V value) throws SerializationException, SaveFailedException; 30 | 31 | /** 32 | * Try to find value for a given key. 33 | * 34 | * @param key of entity that should be retrieved. 35 | * @return Optional of entity. 36 | * @throws SerDeException when it's not possible to serialize/deserialize entity. 37 | * @throws FindFailedException when it's not possible to retrieve a wanted entity. 38 | */ 39 | Optional findByKey(K key) throws SerDeException, FindFailedException; 40 | 41 | /** 42 | * Try to find all entities from repository. 43 | * 44 | * @return Collection of entities. 45 | * @throws DeserializationException when it's not possible to deserialize entity. 46 | */ 47 | Collection findAll() throws DeserializationException; 48 | 49 | /** 50 | * Delete entity for a given key. 51 | * 52 | * @param key of entity that should be deleted. 53 | * @throws SerializationException when it's not possible to serialize entity. 54 | * @throws DeleteFailedException when it's not possible to delete a wanted entity. 55 | */ 56 | void deleteByKey(K key) throws SerializationException, DeleteFailedException; 57 | 58 | /** 59 | * Deletes all entities from RocksDB. 60 | * 61 | * @throws DeleteAllFailedException when it's not possible to delete all entities. 62 | */ 63 | void deleteAll() throws DeleteAllFailedException; 64 | } 65 | -------------------------------------------------------------------------------- /src/main/java/com/github/aleksandarskrbic/rocks4j/core/AsyncKeyValueStore.java: -------------------------------------------------------------------------------- 1 | package com.github.aleksandarskrbic.rocks4j.core; 2 | 3 | import java.util.Collection; 4 | import java.util.Optional; 5 | import java.util.concurrent.CompletionStage; 6 | 7 | import com.github.aleksandarskrbic.rocks4j.core.exception.DeleteAllFailedException; 8 | import com.github.aleksandarskrbic.rocks4j.core.exception.DeleteFailedException; 9 | import com.github.aleksandarskrbic.rocks4j.core.exception.FindFailedException; 10 | import com.github.aleksandarskrbic.rocks4j.core.exception.SaveFailedException; 11 | import com.github.aleksandarskrbic.rocks4j.mapper.exception.DeserializationException; 12 | import com.github.aleksandarskrbic.rocks4j.mapper.exception.SerDeException; 13 | import com.github.aleksandarskrbic.rocks4j.mapper.exception.SerializationException; 14 | 15 | /** 16 | * Interface that defines asynchronous operations against Key-Value Store. 17 | * 18 | * @param Key type. 19 | * @param Value type. 20 | */ 21 | public interface AsyncKeyValueStore { 22 | 23 | /** 24 | * Inserts key-value pair into RocksDB asynchronously. 25 | * 26 | * @param key of value. 27 | * @param value that should be persisted. 28 | * @return CompletableFuture of Void. 29 | * @throws SerializationException when it's not possible to serialize entity. 30 | * @throws SaveFailedException when it's not possible to persist entity. 31 | */ 32 | CompletionStage save(K key, V value) throws SerializationException, SaveFailedException; 33 | 34 | /** 35 | * Try to find value for a given key asynchronously. 36 | * 37 | * @param key of entity that should be retrieved. 38 | * @return CompletableFuture of Optional of entity. 39 | * @throws SerDeException when it's not possible to serialize/deserialize entity. 40 | * @throws FindFailedException when it's not possible to retrieve a wanted entity. 41 | */ 42 | CompletionStage> findByKey(K key) throws SerDeException, FindFailedException; 43 | 44 | /** 45 | * Try to find all entities from repository asynchronously. 46 | * 47 | * @return CompletableFuture of Collection of entities. 48 | * @throws DeserializationException when it's not possible to deserialize entity. 49 | */ 50 | CompletionStage> findAll() throws DeserializationException; 51 | 52 | /** 53 | * Delete entity for a given key asynchronously.. 54 | * 55 | * @param key of entity that should be deleted. 56 | * @return CompletableFuture of Void. 57 | * @throws SerializationException when it's not possible to serialize entity. 58 | * @throws DeleteFailedException when it's not possible to delete a wanted entity. 59 | */ 60 | CompletionStage deleteByKey(K key) throws SerializationException, DeleteFailedException; 61 | 62 | /** 63 | * Deletes all entities from RocksDB asynchronously. 64 | * 65 | * @return CompletableFuture of Void. 66 | * @throws DeleteAllFailedException when it's not possible to delete entity. 67 | */ 68 | CompletionStage deleteAll() throws DeleteAllFailedException; 69 | } 70 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # rocks4j 2 | 3 | KV Store for Java backed by RocksDB. 4 | 5 | ## Getting Started 6 | 7 | ### Maven 8 | ```java 9 | 10 | com.github.aleksandarskrbic 11 | rocks4j 12 | 1.0.0 13 | 14 | ``` 15 | 16 | ### Gradle 17 | ```java 18 | compile "com.github.aleksandarskrbic:rocks4j:1.0.0" 19 | ``` 20 | 21 | ## Introduction 22 | The goal of this project is to provide KV store backed by RocksDB with simple Java API. 23 | Allow developers to quickly integrate RocksDB into the existing Java/Scala project. 24 | It can be used as a local caching mechanism in microservices or just to replace huge in-memory data structures. 25 | 26 | ## API 27 | 28 | There are five available operations against KV repository: 29 | 30 | * `save(K key, V value)` 31 | * `findByKey(K key)` 32 | * `findAll()` 33 | * `deleteByKey(K key)` 34 | * `deleteAll()` 35 | 36 | ## Examples 37 | 38 | Suppose you have a Java class: 39 | 40 | ```java 41 | public class Item { 42 | private Long id; 43 | private String desc; 44 | 45 | // constructors, getters and setters 46 | } 47 | ``` 48 | 49 | To create KV repository for Item class, firstly you need to create a configuration class that accepts a path to file (where RocksDB files will be) and the name of the repository: 50 | 51 | ```java 52 | final RocksDBConfiguration configuration = new RocksDBConfiguration("/path/to/rocksdb", "item"); 53 | ``` 54 | After configuration class is created, you are able to instantiate the Item Repository: 55 | 56 | ```java 57 | public class ItemRepository extends RocksDBKeyValueRepository { 58 | 59 | public ItemRepository(final RocksDBConfiguration configuration) { 60 | super(configuration); 61 | } 62 | 63 | } 64 | ``` 65 | 66 | ```java 67 | final ItemRepository itemRepository = new ItemRepository(configuration); 68 | ``` 69 | 70 | ```java 71 | final Item item = new Item(1L, "Desc") 72 | ``` 73 | 74 | ```java 75 | itemRepository.save(item.getId(), item); 76 | final Optional itemOptional = itemRepository.findByKey(item.getId()); 77 | final Collection all = itemRepository.findAll(); 78 | itemRepository.deleteByKey(item.getId()); 79 | itemRepository.deleteAll(); 80 | ``` 81 | 82 | ## Note 83 | 84 | In order to maintain flexibility, when exception related to `RocksDB` or `Serialization/Deserialization` in `RocksDBKeyValueRepository`, 85 | exceptions are just propagated, so it's a client's responsibility to deal with it. 86 | Best practice would be to override methods from `RocksDBKeyValueRepository` and 87 | handle those exceptions and handle those exceptions into your repository class. 88 | Another solution would be to handle 89 | it every time you invoke methods provided by `RocksDBKeyValueRepository` which is not recommended. 90 | 91 | ### Example 92 | 93 | ```java 94 | public static class ItemRepository extends RocksDBKeyValueRepository { 95 | 96 | public ItemRepository(final RocksDBConfiguration configuration) { 97 | super(configuration); 98 | } 99 | 100 | @Override 101 | public void save(final Long key, final Item value) { 102 | try { 103 | super.save(key, value); 104 | } catch (final SerializationException e) { 105 | // log or handle 106 | } catch (final SaveFailedException e) { 107 | // log or handle 108 | } 109 | } 110 | 111 | // other methods 112 | } 113 | ``` 114 | ## Credits 115 | 116 | Special thanks to [@jovicaandric](https://github.com/jovicaandric) and [@vajda](https://github.com/vajda). 117 | -------------------------------------------------------------------------------- /src/main/java/com/github/aleksandarskrbic/rocks4j/Test.java: -------------------------------------------------------------------------------- 1 | package com.github.aleksandarskrbic.rocks4j; 2 | 3 | import java.util.*; 4 | import java.util.concurrent.CompletableFuture; 5 | 6 | import com.github.aleksandarskrbic.rocks4j.core.AsyncKVStore; 7 | import com.github.aleksandarskrbic.rocks4j.core.RocksDBConfiguration; 8 | import com.github.aleksandarskrbic.rocks4j.core.exception.DeleteAllFailedException; 9 | import com.github.aleksandarskrbic.rocks4j.core.exception.FindFailedException; 10 | import com.github.aleksandarskrbic.rocks4j.core.exception.SaveFailedException; 11 | import com.github.aleksandarskrbic.rocks4j.mapper.exception.SerDeException; 12 | import com.github.aleksandarskrbic.rocks4j.core.KVStore; 13 | 14 | public class Test { 15 | 16 | public static void main(final String[] args) throws SerDeException, SaveFailedException, DeleteAllFailedException, FindFailedException { 17 | final RocksDBConfiguration rocksDBConfiguration = new RocksDBConfiguration("/src/main/resources/data/repositories", "db"); 18 | 19 | final ItemRepository itemRepository = new ItemRepository(rocksDBConfiguration); 20 | 21 | for (int i = 0; i < 100000; i++) { 22 | final Item item = new Item(); 23 | item.setId((long) i); 24 | item.setDesc("Desc"); 25 | final ArrayList ints = new ArrayList<>(); 26 | ints.add(1); 27 | item.setInts(ints); 28 | final ArrayList accounts = new ArrayList<>(); 29 | for (int j = 0; j < 100; j++) { 30 | final Account account = new Account(); 31 | account.setId((long) j); 32 | account.setName("Name " + j); 33 | accounts.add(account); 34 | } 35 | final Optional join = itemRepository.save(item.getId(), item).thenCompose(__ -> itemRepository.findByKey(item.id)).join(); 36 | System.out.println(join); 37 | } 38 | 39 | } 40 | 41 | public static class ItemRepository extends AsyncKVStore { 42 | 43 | public ItemRepository(final RocksDBConfiguration configuration) { 44 | super(configuration); 45 | } 46 | } 47 | 48 | public static class Item { 49 | private Long id; 50 | private String desc; 51 | private List ints; 52 | private List accounts; 53 | 54 | public Long getId() { 55 | return id; 56 | } 57 | 58 | public void setId(Long id) { 59 | this.id = id; 60 | } 61 | 62 | public String getDesc() { 63 | return desc; 64 | } 65 | 66 | public void setDesc(String desc) { 67 | this.desc = desc; 68 | } 69 | 70 | public List getInts() { 71 | return ints; 72 | } 73 | 74 | public void setInts(List ints) { 75 | this.ints = ints; 76 | } 77 | 78 | public List getAccounts() { 79 | return accounts; 80 | } 81 | 82 | public void setAccounts(List accounts) { 83 | this.accounts = accounts; 84 | } 85 | } 86 | 87 | public static class Account { 88 | private Long id; 89 | private String name; 90 | 91 | public Long getId() { 92 | return id; 93 | } 94 | 95 | public void setId(Long id) { 96 | this.id = id; 97 | } 98 | 99 | public String getName() { 100 | return name; 101 | } 102 | 103 | public void setName(String name) { 104 | this.name = name; 105 | } 106 | } 107 | } 108 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | com.github.aleksandarskrbic 8 | rocks4j 9 | 0.2.0 10 | 11 | 12 | 13 | org.apache.maven.plugins 14 | maven-compiler-plugin 15 | 16 | 9 17 | 9 18 | 19 | 20 | 21 | org.sonatype.plugins 22 | nexus-staging-maven-plugin 23 | 1.6.7 24 | true 25 | 26 | ossrh 27 | https://oss.sonatype.org/ 28 | true 29 | 30 | 31 | 32 | org.apache.maven.plugins 33 | maven-source-plugin 34 | 2.2.1 35 | 36 | 37 | attach-sources 38 | 39 | jar-no-fork 40 | 41 | 42 | 43 | 44 | 45 | org.apache.maven.plugins 46 | maven-javadoc-plugin 47 | 3.0.0 48 | 49 | 50 | attach-javadocs 51 | 52 | jar 53 | 54 | 55 | 56 | 57 | 58 | -Xdoclint:none 59 | 60 | 61 | 62 | 63 | org.apache.maven.plugins 64 | maven-gpg-plugin 65 | 1.6 66 | 67 | 68 | sign-artifacts 69 | verify 70 | 71 | sign 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | ossrh 81 | https://oss.sonatype.org/content/repositories/snapshots 82 | 83 | 84 | ossrh 85 | https://oss.sonatype.org/service/local/staging/deploy/maven2 86 | 87 | 88 | jar 89 | 90 | rocks4j 91 | Persistent KV store for Java backed by RocksDB 92 | https://github.com/aleksandarskrbic/rocks4j 93 | 94 | 95 | 96 | Aleksandar Skrbic 97 | skrbic.alexa@gmail.com 98 | https://github.com/aleksandarskrbic/rocks4j 99 | 100 | 101 | Jovica Andric 102 | jovica.andrickv@hotmail.com 103 | https://github.com/aleksandarskrbic/rocks4j 104 | 105 | 106 | 107 | 108 | 109 | GNU General Public License v3.0 110 | https://www.gnu.org/licenses/gpl-3.0.en.html 111 | 112 | 113 | 114 | 115 | scm:git:git://github.com/aleksandarskrbic/rocks4j.git 116 | scm:git:ssh://github.com:aleksandarskrbic/rocks4j.git 117 | http://github.com/aleksandarskrbic/rocks4j/tree/0.1.0 118 | 119 | 120 | 121 | 122 | org.rocksdb 123 | rocksdbjni 124 | 6.15.2 125 | 126 | 127 | com.fasterxml.jackson.core 128 | jackson-core 129 | 2.12.1 130 | 131 | 132 | com.fasterxml.jackson.core 133 | jackson-databind 134 | 2.12.6.1 135 | 136 | 137 | org.apache.logging.log4j 138 | log4j-api 139 | 2.7 140 | 141 | 142 | org.apache.logging.log4j 143 | log4j-core 144 | 2.17.1 145 | 146 | 147 | org.apache.logging.log4j 148 | log4j-slf4j-impl 149 | 2.7 150 | 151 | 152 | -------------------------------------------------------------------------------- /src/main/java/com/github/aleksandarskrbic/rocks4j/core/AsyncKVStore.java: -------------------------------------------------------------------------------- 1 | package com.github.aleksandarskrbic.rocks4j.core; 2 | 3 | import java.lang.reflect.ParameterizedType; 4 | import java.lang.reflect.Type; 5 | import java.util.Collection; 6 | import java.util.Optional; 7 | import java.util.concurrent.CompletableFuture; 8 | import java.util.concurrent.ExecutorService; 9 | import java.util.concurrent.Executors; 10 | 11 | import com.github.aleksandarskrbic.rocks4j.core.exception.DeleteAllFailedException; 12 | import com.github.aleksandarskrbic.rocks4j.core.exception.DeleteFailedException; 13 | import com.github.aleksandarskrbic.rocks4j.core.exception.FindFailedException; 14 | import com.github.aleksandarskrbic.rocks4j.core.exception.SaveFailedException; 15 | import com.github.aleksandarskrbic.rocks4j.mapper.JsonMapper; 16 | import com.github.aleksandarskrbic.rocks4j.mapper.Mapper; 17 | import com.github.aleksandarskrbic.rocks4j.mapper.exception.DeserializationException; 18 | import com.github.aleksandarskrbic.rocks4j.mapper.exception.SerDeException; 19 | import com.github.aleksandarskrbic.rocks4j.mapper.exception.SerializationException; 20 | import org.slf4j.Logger; 21 | import org.slf4j.LoggerFactory; 22 | 23 | /** 24 | * Base class that should be extended by the concrete asynchronous repository. 25 | * 26 | * @param Key type. 27 | * @param Value type. 28 | */ 29 | public abstract class AsyncKVStore implements AsyncKeyValueStore { 30 | 31 | private static final Logger LOGGER = LoggerFactory.getLogger(AsyncKVStore.class); 32 | 33 | private final KVStore underlying; 34 | private final ExecutorService executorService; 35 | 36 | /** 37 | * Default constructor which automatically infers key and value types needed for mapper creation. 38 | * Uses {@link JsonMapper}. 39 | * 40 | * @param configuration for {@link RocksDBConnection}. 41 | */ 42 | public AsyncKVStore(final RocksDBConfiguration configuration) { 43 | this.underlying = new KVStore<>(configuration, extractKeyType(), extractValueType()); 44 | this.executorService = Executors.newFixedThreadPool(configuration.threadCount()); 45 | } 46 | 47 | /** 48 | * 49 | * @param configuration for {@link RocksDBConnection}. 50 | * @param keyType for mapper. 51 | * @param valueType for mapper. 52 | */ 53 | public AsyncKVStore( 54 | final RocksDBConfiguration configuration, 55 | final Class keyType, 56 | final Class valueType 57 | ) { 58 | this.underlying = new KVStore<>(configuration, keyType, valueType); 59 | this.executorService = Executors.newFixedThreadPool(configuration.threadCount()); 60 | } 61 | 62 | /** 63 | * 64 | * @param configuration for {@link RocksDBConnection}. 65 | * @param keyMapper custom key mapper that implements {@link Mapper}. 66 | * @param valueMapper custom value mapper that implements {@link Mapper}. 67 | */ 68 | public AsyncKVStore( 69 | final RocksDBConfiguration configuration, 70 | final Mapper keyMapper, 71 | final Mapper valueMapper 72 | ) { 73 | this.underlying = new KVStore<>(configuration, keyMapper, valueMapper); 74 | this.executorService = Executors.newFixedThreadPool(configuration.threadCount()); 75 | } 76 | 77 | @Override 78 | public CompletableFuture save( 79 | final K key, 80 | final V value 81 | ) { 82 | final CompletableFuture future = new CompletableFuture<>(); 83 | 84 | CompletableFuture.runAsync(() -> { 85 | try { 86 | underlying.save(key, value); 87 | future.complete(null); 88 | } catch (final SerializationException | SaveFailedException exception) { 89 | future.completeExceptionally(exception); 90 | } 91 | }, executorService); 92 | 93 | return future; 94 | } 95 | 96 | @Override 97 | public CompletableFuture> findByKey(final K key) { 98 | final CompletableFuture> future = new CompletableFuture<>(); 99 | 100 | CompletableFuture.runAsync(() -> { 101 | try { 102 | future.complete(underlying.findByKey(key)); 103 | } catch (final SerDeException | FindFailedException exception) { 104 | future.completeExceptionally(exception); 105 | } 106 | }, executorService); 107 | 108 | return future; 109 | } 110 | 111 | @Override 112 | public CompletableFuture> findAll() { 113 | final CompletableFuture> future = new CompletableFuture<>(); 114 | 115 | CompletableFuture.runAsync(() -> { 116 | try { 117 | future.complete(underlying.findAll()); 118 | } catch (final DeserializationException exception) { 119 | future.completeExceptionally(exception); 120 | } 121 | }, executorService); 122 | 123 | return future; 124 | } 125 | 126 | @Override 127 | public CompletableFuture deleteByKey(final K key) { 128 | final CompletableFuture future = new CompletableFuture<>(); 129 | 130 | CompletableFuture.runAsync(() -> { 131 | try { 132 | underlying.deleteByKey(key); 133 | future.complete(null); 134 | } catch (final SerializationException | DeleteFailedException exception) { 135 | future.completeExceptionally(exception); 136 | } 137 | }, executorService); 138 | 139 | return future; 140 | } 141 | 142 | @Override 143 | public CompletableFuture deleteAll() { 144 | final CompletableFuture future = new CompletableFuture<>(); 145 | 146 | CompletableFuture.runAsync(() -> { 147 | try { 148 | underlying.deleteAll(); 149 | future.complete(null); 150 | } catch (final DeleteAllFailedException exception) { 151 | future.completeExceptionally(exception); 152 | } 153 | }, executorService); 154 | 155 | return future; 156 | } 157 | 158 | @SuppressWarnings("unchecked") 159 | private Class extractKeyType() { 160 | return (Class) extractClass(((ParameterizedType) getGenericSuperClass()).getActualTypeArguments()[0]); 161 | } 162 | 163 | @SuppressWarnings("unchecked") 164 | private Class extractValueType() { 165 | return (Class) extractClass(((ParameterizedType) getGenericSuperClass()).getActualTypeArguments()[1]); 166 | } 167 | 168 | private Type getGenericSuperClass() { 169 | final Type superClass = getClass().getGenericSuperclass(); 170 | 171 | if (superClass instanceof Class) { 172 | throw new IllegalArgumentException("Internal error: TypeReference constructed without actual type information"); 173 | } 174 | 175 | return superClass; 176 | } 177 | 178 | private Class extractClass(final Type type) { 179 | if (type instanceof Class) { 180 | return (Class) type; 181 | } 182 | 183 | throw new IllegalArgumentException("Internal error: TypeReference constructed without actual type information"); 184 | } 185 | } 186 | -------------------------------------------------------------------------------- /src/main/java/com/github/aleksandarskrbic/rocks4j/core/KVStore.java: -------------------------------------------------------------------------------- 1 | package com.github.aleksandarskrbic.rocks4j.core; 2 | 3 | import java.lang.reflect.ParameterizedType; 4 | import java.lang.reflect.Type; 5 | import java.util.*; 6 | 7 | import com.github.aleksandarskrbic.rocks4j.core.exception.DeleteAllFailedException; 8 | import com.github.aleksandarskrbic.rocks4j.core.exception.DeleteFailedException; 9 | import com.github.aleksandarskrbic.rocks4j.core.exception.FindFailedException; 10 | import com.github.aleksandarskrbic.rocks4j.core.exception.SaveFailedException; 11 | import com.github.aleksandarskrbic.rocks4j.mapper.JsonMapper; 12 | import com.github.aleksandarskrbic.rocks4j.mapper.Mapper; 13 | import com.github.aleksandarskrbic.rocks4j.mapper.MapperFactory; 14 | import com.github.aleksandarskrbic.rocks4j.mapper.exception.DeserializationException; 15 | import com.github.aleksandarskrbic.rocks4j.mapper.exception.SerDeException; 16 | import com.github.aleksandarskrbic.rocks4j.mapper.exception.SerializationException; 17 | import org.rocksdb.RocksDBException; 18 | import org.rocksdb.RocksIterator; 19 | import org.slf4j.Logger; 20 | import org.slf4j.LoggerFactory; 21 | 22 | /** 23 | * Base class that should be extended by the concrete repository. 24 | * 25 | * @param Key type. 26 | * @param Value type. 27 | */ 28 | public class KVStore extends RocksDBConnection implements KeyValueStore { 29 | 30 | private static final Logger LOGGER = LoggerFactory.getLogger(KVStore.class); 31 | 32 | private final Mapper keyMapper; 33 | private final Mapper valueMapper; 34 | 35 | /** 36 | * Default constructor which automatically infers key and value types needed for mapper creation. 37 | * Uses {@link JsonMapper}. 38 | * 39 | * @param configuration for {@link RocksDBConnection}. 40 | */ 41 | public KVStore(final RocksDBConfiguration configuration) { 42 | super(configuration); 43 | this.keyMapper = MapperFactory.createFor(extractKeyType()); 44 | this.valueMapper = MapperFactory.createFor(extractValueType()); 45 | } 46 | 47 | /** 48 | * 49 | * @param configuration for {@link RocksDBConnection}. 50 | * @param keyType for mapper. 51 | * @param valueType for mapper. 52 | */ 53 | public KVStore( 54 | final RocksDBConfiguration configuration, 55 | final Class keyType, 56 | final Class valueType 57 | ) { 58 | super(configuration); 59 | this.keyMapper = MapperFactory.createFor(keyType); 60 | this.valueMapper = MapperFactory.createFor(valueType); 61 | } 62 | 63 | /** 64 | * 65 | * @param configuration for {@link RocksDBConnection}. 66 | * @param keyMapper custom key mapper that implements {@link Mapper}. 67 | * @param valueMapper custom value mapper that implements {@link Mapper}. 68 | */ 69 | public KVStore( 70 | final RocksDBConfiguration configuration, 71 | final Mapper keyMapper, 72 | final Mapper valueMapper 73 | ) { 74 | super(configuration); 75 | this.keyMapper = keyMapper; 76 | this.valueMapper = valueMapper; 77 | } 78 | 79 | @Override 80 | public void save( 81 | final K key, 82 | final V value 83 | ) throws SerializationException, SaveFailedException { 84 | try { 85 | final byte[] serializedKey = keyMapper.serialize(key); 86 | final byte[] serializedValue = valueMapper.serialize(value); 87 | rocksDB.put(serializedKey, serializedValue); 88 | } catch (final SerializationException exception) { 89 | LOGGER.error("Serialization exception occurred during save operation. {}", exception.getMessage()); 90 | throw exception; 91 | } catch (final RocksDBException exception) { 92 | LOGGER.error("RocksDBException occurred during save operation. {}", exception.getMessage()); 93 | throw new SaveFailedException(exception.getMessage(), exception); 94 | } 95 | } 96 | 97 | @Override 98 | public Optional findByKey(final K key) throws SerDeException, FindFailedException { 99 | try { 100 | final byte[] serializedKey = keyMapper.serialize(key); 101 | final byte[] bytes = rocksDB.get(serializedKey); 102 | return Optional.ofNullable(valueMapper.deserialize(bytes)); 103 | } catch (final SerializationException exception) { 104 | LOGGER.error("Serialization exception occurred during findByKey operation. {}", exception.getMessage()); 105 | throw exception; 106 | } catch (final RocksDBException exception) { 107 | LOGGER.error("RocksDBException occurred during findByKey operation. {}", exception.getMessage()); 108 | throw new FindFailedException(exception.getMessage(), exception); 109 | } catch (final DeserializationException exception) { 110 | LOGGER.error("Deserialization exception occurred during findByKey operation. {}", exception.getMessage()); 111 | throw exception; 112 | } 113 | } 114 | 115 | @Override 116 | public Collection findAll() throws DeserializationException { 117 | try (final RocksIterator iterator = rocksDB.newIterator()) { 118 | final Collection result = new ArrayList<>(); 119 | iterator.seekToFirst(); 120 | 121 | while (iterator.isValid()) { 122 | final V value = valueMapper.deserialize(iterator.value()); 123 | result.add(value); 124 | iterator.next(); 125 | } 126 | 127 | return result; 128 | } catch (final DeserializationException exception) { 129 | LOGGER.error("Deserialization exception occurred during findAll operation. {}", exception.getMessage()); 130 | throw exception; 131 | } 132 | } 133 | 134 | @Override 135 | public void deleteByKey(final K key) throws SerializationException, DeleteFailedException { 136 | try { 137 | final byte[] serializedKey = keyMapper.serialize(key); 138 | rocksDB.delete(serializedKey); 139 | } catch (final SerializationException exception) { 140 | LOGGER.error("Serialization exception occurred during findByKey operation. {}", exception.getMessage()); 141 | throw exception; 142 | } catch (final RocksDBException exception) { 143 | LOGGER.error("RocksDBException occurred during deleteByKey operation. {}", exception.getMessage()); 144 | throw new DeleteFailedException(exception.getMessage(), exception); 145 | } 146 | } 147 | 148 | @Override 149 | public void deleteAll() throws DeleteAllFailedException { 150 | final RocksIterator iterator = rocksDB.newIterator(); 151 | 152 | iterator.seekToFirst(); 153 | final byte[] firstKey = getKey(iterator); 154 | 155 | iterator.seekToLast(); 156 | final byte[] lastKey = getKey(iterator); 157 | 158 | if (firstKey == null || lastKey == null) { 159 | return; 160 | } 161 | 162 | try { 163 | rocksDB.deleteRange(firstKey, lastKey); 164 | rocksDB.delete(lastKey); 165 | } catch (final RocksDBException exception) { 166 | LOGGER.error("RocksDBException occurred during deleteAll operation. {}", exception.getMessage()); 167 | throw new DeleteAllFailedException(exception.getMessage(), exception); 168 | } finally { 169 | iterator.close(); 170 | } 171 | } 172 | 173 | private byte[] getKey(final RocksIterator iterator) { 174 | if (!iterator.isValid()) { 175 | return null; 176 | } 177 | return iterator.key(); 178 | } 179 | 180 | @SuppressWarnings("unchecked") 181 | private Class extractKeyType() { 182 | return (Class) extractClass(((ParameterizedType) getGenericSuperClass()).getActualTypeArguments()[0]); 183 | } 184 | 185 | @SuppressWarnings("unchecked") 186 | private Class extractValueType() { 187 | return (Class) extractClass(((ParameterizedType) getGenericSuperClass()).getActualTypeArguments()[1]); 188 | } 189 | 190 | private Type getGenericSuperClass() { 191 | final Type superClass = getClass().getGenericSuperclass(); 192 | 193 | if (superClass instanceof Class) { 194 | throw new IllegalArgumentException("Internal error: TypeReference constructed without actual type information"); 195 | } 196 | 197 | return superClass; 198 | } 199 | 200 | private Class extractClass(final Type type) { 201 | if (type instanceof Class) { 202 | return (Class) type; 203 | } 204 | 205 | throw new IllegalArgumentException("Internal error: TypeReference constructed without actual type information"); 206 | } 207 | } 208 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------