com.aerospike.mapper.tools.AeroMapper Maven / Gradle / Ivy
package com.aerospike.mapper.tools;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.List;
import java.util.function.Function;
import javax.validation.constraints.NotNull;
import org.apache.commons.lang3.StringUtils;
import com.aerospike.client.AerospikeException;
import com.aerospike.client.Bin;
import com.aerospike.client.IAerospikeClient;
import com.aerospike.client.Key;
import com.aerospike.client.Record;
import com.aerospike.client.Value;
import com.aerospike.client.policy.BatchPolicy;
import com.aerospike.client.policy.Policy;
import com.aerospike.client.policy.QueryPolicy;
import com.aerospike.client.policy.RecordExistsAction;
import com.aerospike.client.policy.ScanPolicy;
import com.aerospike.client.policy.WritePolicy;
import com.aerospike.client.query.RecordSet;
import com.aerospike.client.query.Statement;
import com.aerospike.mapper.tools.ClassCache.PolicyType;
import com.aerospike.mapper.tools.configuration.ClassConfig;
import com.aerospike.mapper.tools.configuration.Configuration;
import com.aerospike.mapper.tools.converters.MappingConverter;
import com.aerospike.mapper.tools.utils.MapperUtils;
import com.aerospike.mapper.tools.utils.TypeUtils;
import com.aerospike.mapper.tools.virtuallist.VirtualList;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
public class AeroMapper implements IAeroMapper {
private final IAerospikeClient mClient;
private final MappingConverter mappingConverter;
public static class Builder {
private final AeroMapper mapper;
private List> classesToPreload = null;
public Builder(IAerospikeClient client) {
this.mapper = new AeroMapper(client);
ClassCache.getInstance().setDefaultPolicies(client);
}
/**
* Add in a custom type converter. The converter must have methods which implement the ToAerospike and FromAerospike annotation.
* @param converter The custom converter
* @return this object
*/
public Builder addConverter(Object converter) {
GenericTypeMapper mapper = new GenericTypeMapper(converter);
TypeUtils.addTypeMapper(mapper.getMappedClass(), mapper);
return this;
}
public Builder preLoadClass(Class clazz) {
if (classesToPreload == null) {
classesToPreload = new ArrayList<>();
}
classesToPreload.add(clazz);
return this;
}
public Builder withConfigurationFile(File file) throws IOException {
return this.withConfigurationFile(file, false);
}
public Builder withConfigurationFile(File file, boolean allowsInvalid) throws IOException {
ObjectMapper objectMapper = new ObjectMapper(new YAMLFactory());
Configuration configuration = objectMapper.readValue(file, Configuration.class);
this.loadConfiguration(configuration, allowsInvalid);
return this;
}
public Builder withConfigurationFile(InputStream ios) throws IOException {
return this.withConfigurationFile(ios, false);
}
public Builder withConfigurationFile(InputStream ios, boolean allowsInvalid) throws IOException {
ObjectMapper objectMapper = new ObjectMapper(new YAMLFactory());
Configuration configuration = objectMapper.readValue(ios, Configuration.class);
this.loadConfiguration(configuration, allowsInvalid);
return this;
}
public Builder withConfiguration(String configurationYaml) throws JsonProcessingException {
return this.withConfiguration(configurationYaml, false);
}
public Builder withConfiguration(String configurationYaml, boolean allowsInvalid) throws JsonProcessingException {
ObjectMapper objectMapper = new ObjectMapper(new YAMLFactory());
Configuration configuration = objectMapper.readValue(configurationYaml, Configuration.class);
this.loadConfiguration(configuration, allowsInvalid);
return this;
}
private void loadConfiguration(@NotNull Configuration configuration, boolean allowsInvalid) {
for (ClassConfig config : configuration.getClasses()) {
try {
String name = config.getClassName();
if (StringUtils.isBlank(name)) {
throw new AerospikeException("Class with blank name in configuration file");
}
else {
try {
Class.forName(config.getClassName());
} catch (ClassNotFoundException e) {
throw new AerospikeException("Cannot find a class with name " + name);
}
}
}
catch (RuntimeException re) {
if (allowsInvalid) {
System.err.println("Ignoring issue with configuration: " + re.getMessage());
}
else {
throw re;
}
}
}
ClassCache.getInstance().addConfiguration(configuration);
}
public static class AeroPolicyMapper {
private final Builder builder;
private final Policy policy;
private final PolicyType policyType;
public AeroPolicyMapper(Builder builder, PolicyType policyType, Policy policy) {
this.builder = builder;
this.policyType = policyType;
this.policy = policy;
}
public Builder forClasses(Class... classes) {
for (Class thisClass : classes) {
ClassCache.getInstance().setSpecificPolicy(policyType, thisClass, policy);
}
return builder;
}
public Builder forThisOrChildrenOf(Class clazz) {
ClassCache.getInstance().setChildrenPolicy(this.policyType, clazz, this.policy);
return builder;
}
public Builder forAll() {
ClassCache.getInstance().setDefaultPolicy(policyType, policy);
return builder;
}
}
public AeroPolicyMapper withReadPolicy(Policy policy) {
return new AeroPolicyMapper(this, PolicyType.READ, policy);
}
public AeroPolicyMapper withWritePolicy(Policy policy) {
return new AeroPolicyMapper(this, PolicyType.WRITE, policy);
}
public AeroPolicyMapper withBatchPolicy(BatchPolicy policy) {
return new AeroPolicyMapper(this, PolicyType.BATCH, policy);
}
public AeroPolicyMapper withScanPolicy(ScanPolicy policy) {
return new AeroPolicyMapper(this, PolicyType.SCAN, policy);
}
public AeroPolicyMapper withQueryPolicy(QueryPolicy policy) {
return new AeroPolicyMapper(this, PolicyType.QUERY, policy);
}
public AeroMapper build() {
if (classesToPreload != null) {
for (Class clazz : classesToPreload) {
ClassCache.getInstance().loadClass(clazz, this.mapper);
}
}
return this.mapper;
}
}
private AeroMapper(@NotNull IAerospikeClient client) {
this.mClient = client;
this.mappingConverter = new MappingConverter(this, mClient);
}
/**
* Save each object in the database. This method will perform a REPLACE on the existing record so any existing
* data will be overwritten by the data in the passed object. This is a convenience method for
*
* save(A);
* save(B);
* save(C);
*
* Not that no transactionality is implied by this method -- if any of the save methods fail, the exception will be
* thrown without trying the other objects, nor attempting to roll back previously saved objects
* @param objects One or two objects to save.
* @throws AerospikeException an AerospikeException will be thrown in case of an error.
*/
@Override
public void save(@NotNull Object... objects) throws AerospikeException {
for (Object thisObject : objects) {
this.save(thisObject);
}
}
/**
* Save an object in the database. This method will perform a REPLACE on the existing record so any existing
* data will be overwritten by the data in the passed object
* @param object The object to save.
* @throws AerospikeException an AerospikeException will be thrown in case of an error.
*/
@Override
public void save(@NotNull Object object, String... binNames) throws AerospikeException {
save(null, object, RecordExistsAction.REPLACE, binNames);
}
/**
* Save an object in the database with the given WritePolicy. This write policy will override any other set writePolicy so
* is effectively an upsert operation
* @param writePolicy The write policy for the save operation.
* @param object The object to save.
* @throws AerospikeException an AerospikeException will be thrown in case of an error.
*/
@Override
public void save(@NotNull WritePolicy writePolicy, @NotNull Object object, String... binNames) throws AerospikeException {
save(writePolicy, object, null, binNames);
}
private void save(WritePolicy writePolicy, @NotNull T object, RecordExistsAction recordExistsAction, String[] binNames) {
Class clazz = (Class) object.getClass();
ClassCacheEntry entry = MapperUtils.getEntryAndValidateNamespace(clazz, this);
if (writePolicy == null) {
writePolicy = new WritePolicy(entry.getWritePolicy());
if (recordExistsAction != null) {
writePolicy.recordExistsAction = recordExistsAction;
}
}
String set = entry.getSetName();
if ("".equals(set)) {
// Use the null set
set = null;
}
Integer ttl = entry.getTtl();
Boolean sendKey = entry.getSendKey();
if (ttl != null) {
writePolicy.expiration = ttl;
}
if (sendKey != null) {
writePolicy.sendKey = sendKey;
}
Key key = new Key(entry.getNamespace(), set, Value.get(entry.getKey(object)));
Bin[] bins = entry.getBins(object, writePolicy.recordExistsAction != RecordExistsAction.REPLACE, binNames);
mClient.put(writePolicy, key, bins);
}
/**
* Updates the object in the database, merging the record with the existing record. This uses the RecordExistsAction
* of UPDATE. If bins are specified, only bins with the passed names will be updated (or all of them if null is passed)
* @param object The object to update.
* @throws AerospikeException an AerospikeException will be thrown in case of an error.
*/
@Override
public void update(@NotNull Object object, String... binNames) throws AerospikeException {
save(null, object, RecordExistsAction.UPDATE, binNames);
}
/**
* Read a record from the repository and map it to an instance of the passed class, by providing a digest.
* @param clazz - The type of the record.
* @param digest - The Aerospike digest (Unique server hash value generated from set name and user key).
* @return The returned mapped record.
* @throws AerospikeException an AerospikeException will be thrown in case of an error.
*/
@Override
public T readFromDigest(@NotNull Class clazz, @NotNull byte[] digest) throws AerospikeException {
return this.readFromDigest(clazz, digest, true);
}
/**
* This method should not be used except by mappers
*/
@Override
public T readFromDigest(@NotNull Class clazz, @NotNull byte[] digest, boolean resolveDependencies) throws AerospikeException {
ClassCacheEntry entry = MapperUtils.getEntryAndValidateNamespace(clazz, this);
Key key = new Key(entry.getNamespace(), digest, entry.getSetName(), null);
return this.read(null, clazz, key, entry, resolveDependencies);
}
/**
* Read a record from the repository and map it to an instance of the passed class, by providing a digest.
* @param readPolicy - The read policy for the read operation.
* @param clazz - The type of the record.
* @param digest - The Aerospike digest (Unique server hash value generated from set name and user key).
* @return The returned mapped record.
* @throws AerospikeException an AerospikeException will be thrown in case of an error.
*/
@Override
public T readFromDigest(Policy readPolicy, @NotNull Class clazz, @NotNull byte[] digest) throws AerospikeException {
return this.readFromDigest(readPolicy, clazz, digest, true);
}
/**
* This method should not be used except by mappers
*/
@Override
public T readFromDigest(Policy readPolicy, @NotNull Class clazz, @NotNull byte[] digest, boolean resolveDependencies) throws AerospikeException {
ClassCacheEntry entry = MapperUtils.getEntryAndValidateNamespace(clazz, this);
Key key = new Key(entry.getNamespace(), digest, entry.getSetName(), null);
return this.read(readPolicy, clazz, key, entry, resolveDependencies);
}
/**
* Read a record from the repository and map it to an instance of the passed class.
* @param clazz - The type of be returned.
* @param userKey - The key of the record. The namespace and set will be derived from the values specified on the passed class.
* @return The returned mapped record.
* @throws AerospikeException an AerospikeException will be thrown in case of an error.
*/
@Override
public T read(@NotNull Class clazz, @NotNull Object userKey) throws AerospikeException {
return this.read(clazz, userKey, true);
}
/**
* This method should not be used: It is used by mappers to correctly resolved dependencies. Use read(clazz, userKey) instead
*/
@Override
public T read(@NotNull Class clazz, @NotNull Object userKey, boolean resolveDependencies) throws AerospikeException {
ClassCacheEntry entry = MapperUtils.getEntryAndValidateNamespace(clazz, this);
String set = entry.getSetName();
Key key = new Key(entry.getNamespace(), set, Value.get(entry.translateKeyToAerospikeKey(userKey)));
return read(null, clazz, key, entry, resolveDependencies);
}
/**
* Read a record from the repository and map it to an instance of the passed class.
* @param readPolicy - The read policy for the read operation.
* @param clazz - The type of be returned.
* @param userKey - The key of the record. The namespace and set will be derived from the values specified on the passed class.
* @return The returned mapped record.
* @throws AerospikeException an AerospikeException will be thrown in case of an error.
*/
@Override
public T read(Policy readPolicy, @NotNull Class clazz, @NotNull Object userKey) throws AerospikeException {
return this.read(readPolicy, clazz, userKey, true);
}
/**
* This method should not be used except by mappers
*/
@Override
public T read(Policy readPolicy, @NotNull Class clazz, @NotNull Object userKey, boolean resolveDependencies) throws AerospikeException {
ClassCacheEntry entry = MapperUtils.getEntryAndValidateNamespace(clazz, this);
String set = entry.getSetName();
Key key = new Key(entry.getNamespace(), set, Value.get(entry.translateKeyToAerospikeKey(userKey)));
return read(readPolicy, clazz, key, entry, resolveDependencies);
}
/**
* Read a batch of records from the repository and map them to an instance of the passed class.
* @param clazz - The type of be returned.
* @param userKeys - The keys of the record. The namespace and set will be derived from the values specified on the passed class.
* @return The returned mapped records.
* @throws AerospikeException an AerospikeException will be thrown in case of an error.
*/
@Override
public T[] read(@NotNull Class clazz, @NotNull Object... userKeys) throws AerospikeException {
return this.read(null, clazz, userKeys);
}
/**
* Read a batch of records from the repository and map them to an instance of the passed class.
* @param batchPolicy A given batch policy.
* @param clazz - The type of be returned.
* @param userKeys - The keys of the record. The namespace and set will be derived from the values specified on the passed class.
* @return The returned mapped records.
* @throws AerospikeException an AerospikeException will be thrown in case of an error.
*/
@Override
public T[] read(BatchPolicy batchPolicy, @NotNull Class clazz, @NotNull Object... userKeys) throws AerospikeException {
ClassCacheEntry entry = MapperUtils.getEntryAndValidateNamespace(clazz, this);
String set = entry.getSetName();
Key[] keys = new Key[userKeys.length];
for (int i = 0; i < userKeys.length; i++) {
if (userKeys[i] == null) {
throw new AerospikeException("Cannot pass null to object " + i + " in multi-read call");
}
else {
keys[i] = new Key(entry.getNamespace(), set, Value.get(entry.translateKeyToAerospikeKey(userKeys[i])));
}
}
return readBatch(batchPolicy, clazz, keys, entry);
}
@SuppressWarnings("unchecked")
private T read(Policy readPolicy, @NotNull Class clazz, @NotNull Key key, @NotNull ClassCacheEntry entry, boolean resolveDependencies) {
Object objectForKey = LoadedObjectResolver.get(key);
if (objectForKey != null) {
return (T)objectForKey;
}
if (readPolicy == null) {
readPolicy = entry.getReadPolicy();
}
Record record = mClient.get(readPolicy, key);
if (record == null) {
return null;
} else {
try {
ThreadLocalKeySaver.save(key);
LoadedObjectResolver.begin();
return mappingConverter.convertToObject(clazz, record, entry, resolveDependencies);
} catch (ReflectiveOperationException e) {
throw new AerospikeException(e);
}
finally {
LoadedObjectResolver.end();
ThreadLocalKeySaver.clear();
}
}
}
private T[] readBatch(BatchPolicy batchPolicy, @NotNull Class clazz, @NotNull Key[] keys, @NotNull ClassCacheEntry entry) {
if (batchPolicy == null) {
batchPolicy = entry.getBatchPolicy();
}
Record[] records = mClient.get(batchPolicy, keys);
T[] results = (T[])Array.newInstance(clazz, records.length);
for (int i = 0; i < records.length; i++) {
if (records[i] == null) {
results[i] = null;
}
else {
try {
ThreadLocalKeySaver.save(keys[i]);
T result = mappingConverter.convertToObject(clazz, records[i], entry, false);
results[i] = result;
} catch (ReflectiveOperationException e) {
throw new AerospikeException(e);
}
finally {
ThreadLocalKeySaver.clear();
}
}
}
mappingConverter.resolveDependencies(entry);
return results;
}
/**
* Delete a record by specifying a class and a user key.
* @param clazz - The type of the record.
* @param userKey - The key of the record. The namespace and set will be derived from the values specified on the passed class.
* @return whether record existed on server before deletion
* @throws AerospikeException an AerospikeException will be thrown in case of an error.
*/
@Override
public boolean delete(@NotNull Class clazz, @NotNull Object userKey) throws AerospikeException {
return this.delete(null, clazz, userKey);
}
/**
* Delete a record by specifying a write policy, a class and a user key.
* @param writePolicy - The write policy for the delete operation.
* @param clazz - The type of the record.
* @param userKey - The key of the record. The namespace and set will be derived from the values specified on the passed class.
* @return whether record existed on server before deletion
* @throws AerospikeException an AerospikeException will be thrown in case of an error.
*/
@Override
public boolean delete(WritePolicy writePolicy, @NotNull Class clazz, @NotNull Object userKey) throws AerospikeException {
ClassCacheEntry entry = MapperUtils.getEntryAndValidateNamespace(clazz, this);
Object asKey = entry.translateKeyToAerospikeKey(userKey);
if (writePolicy == null) {
writePolicy = entry.getWritePolicy();
if (entry.getDurableDelete() != null) {
// Clone the write policy so we're not changing the original one
writePolicy = new WritePolicy(writePolicy);
writePolicy.durableDelete = entry.getDurableDelete();
}
}
Key key = new Key(entry.getNamespace(), entry.getSetName(), Value.get(asKey));
return mClient.delete(writePolicy, key);
}
/**
* Delete a record by specifying an object.
* @param object The object to delete.
* @return whether record existed on server before deletion
* @throws AerospikeException an AerospikeException will be thrown in case of an error.
*/
@Override
public boolean delete(@NotNull Object object) throws AerospikeException {
return this.delete((WritePolicy)null, object);
}
/**
* Delete a record by specifying a write policy and an object.
* @param writePolicy - The write policy for the delete operation.
* @param object The object to delete.
* @return whether record existed on server before deletion
* @throws AerospikeException an AerospikeException will be thrown in case of an error.
*/
@Override
public boolean delete(WritePolicy writePolicy, @NotNull Object object) throws AerospikeException {
ClassCacheEntry entry = MapperUtils.getEntryAndValidateNamespace(object.getClass(), this);
Key key = new Key(entry.getNamespace(), entry.getSetName(), Value.get(entry.getKey(object)));
if (writePolicy == null) {
writePolicy = entry.getWritePolicy();
if (entry.getDurableDelete() != null) {
writePolicy = new WritePolicy(writePolicy);
writePolicy.durableDelete = entry.getDurableDelete();
}
}
return mClient.delete(writePolicy, key);
}
/**
* Create a virtual list against an attribute on a class. The list does all operations to the database and does not affect the underlying
* class, and is useful for situation when operations are needed to affect the database without having to return all the elements on the
* list each time.
*
* For example, consider a set of transactions associated with a credit card. Common operations might be
*
* - Return the last N transactions
* - insert a new transaction into the list
*
* These operation can all be done without having the full set of transactions
* @param the type of the elements in the list.
* @param object The object that will use as a base for the virtual list.
* @param binName The Aerospike bin name.
* @param elementClazz The class of the elements in the list.
* @return A virtual list.
*/
@Override
public VirtualList asBackedList(@NotNull Object object, @NotNull String binName, Class elementClazz) {
return new VirtualList<>(this, object, binName, elementClazz);
}
/**
* Create a virtual list against an attribute on a class. The list does all operations to the database and does not affect the underlying
* class, and is useful for situation when operations are needed to affect the database without having to return all the elements on the
* list each time.
*
* Note that the object being mapped does not need to actually exist in this case. The owning class is used purely for the definitions
* of how to map the list elements (are they to be mapped in the database as a list or a map, is each element a list or a map, etc), as
* well as using the namespace / set definition for the location to map into the database. The
* passed key is used to map the object to the database.
*
* For example, consider a set of transactions associated with a credit card. Common operations might be
*
* - Return the last N transactions
* - insert a new transaction into the list
*
* These operation can all be done without having the full set of transactions
* @param the type of the elements in the list.
* @param owningClazz Used for the definitions of how to map the list elements.
* @param key The key to map the object to the database.
* @param binName The Aerospike bin name.
* @param elementClazz The class of the elements in the list.
* @return A virtual list.
*/
@Override
public VirtualList asBackedList(@NotNull Class owningClazz, @NotNull Object key, @NotNull String binName, Class elementClazz) {
return new VirtualList<>(this, owningClazz, key, binName, elementClazz);
}
/**
* Find a record by specifying a class and a Boolean function.
* @param clazz - The type of the record.
* @param function a Boolean function.
* @throws AerospikeException an AerospikeException will be thrown in case of an error.
*/
@Override
public void find(@NotNull Class clazz, Function function) throws AerospikeException {
ClassCacheEntry entry = MapperUtils.getEntryAndValidateNamespace(clazz, this);
Statement statement = new Statement();
statement.setNamespace(entry.getNamespace());
statement.setSetName(entry.getSetName());
RecordSet recordSet = null;
try {
// TODO: set the policy (If this statement is thought to be useful, which is dubious)
recordSet = mClient.query(null, statement);
T result;
while (recordSet.next()) {
result = clazz.getConstructor().newInstance();
entry.hydrateFromRecord(recordSet.getRecord(), result);
if (!function.apply(result)) {
break;
}
}
} catch (ReflectiveOperationException e) {
throw new AerospikeException(e);
} finally {
if (recordSet != null) {
recordSet.close();
}
}
}
@Override
public IAerospikeClient getClient() {
return this.mClient;
}
@Override
public MappingConverter getMappingConverter() {
return this.mappingConverter;
}
/**
* Return the read policy to be used for the passed class. This is a convenience method only and should rarely be needed
* @param clazz - the class to return the read policy for.
* @return - the appropriate read policy. If none is set, the client's readPolicyDefault is returned.
*/
@Override
public Policy getReadPolicy(Class clazz) {
return getPolicyByClassAndType(clazz, PolicyType.READ);
}
/**
* Return the write policy to be used for the passed class. This is a convenience method only and should rarely be needed
* @param clazz - the class to return the write policy for.
* @return - the appropriate write policy. If none is set, the client's writePolicyDefault is returned.
*/
@Override
public WritePolicy getWritePolicy(Class clazz) {
return (WritePolicy) getPolicyByClassAndType(clazz, PolicyType.WRITE);
}
/**
* Return the batch policy to be used for the passed class. This is a convenience method only and should rarely be needed
* @param clazz - the class to return the batch policy for.
* @return - the appropriate batch policy. If none is set, the client's batchPolicyDefault is returned.
*/
@Override
public BatchPolicy getBatchPolicy(Class clazz) {
return (BatchPolicy) getPolicyByClassAndType(clazz, PolicyType.BATCH);
}
/**
* Return the scan policy to be used for the passed class. This is a convenience method only and should rarely be needed
* @param clazz - the class to return the scan policy for.
* @return - the appropriate scan policy. If none is set, the client's scanPolicyDefault is returned.
*/
@Override
public ScanPolicy getScanPolicy(Class clazz) {
return (ScanPolicy) getPolicyByClassAndType(clazz, PolicyType.SCAN);
}
/**
* Return the query policy to be used for the passed class. This is a convenience method only and should rarely be needed
* @param clazz - the class to return the query policy for.
* @return - the appropriate query policy. If none is set, the client's queryPolicyDefault is returned.
*/
@Override
public QueryPolicy getQueryPolicy(Class clazz) {
return (QueryPolicy) getPolicyByClassAndType(clazz, PolicyType.QUERY);
}
@Override
public IAeroMapper asMapper() {
return this;
}
private Policy getPolicyByClassAndType(Class clazz, PolicyType policyType) {
ClassCacheEntry entry = ClassCache.getInstance().loadClass(clazz, this);
switch (policyType) {
case READ: return entry == null ? mClient.getReadPolicyDefault() : entry.getReadPolicy();
case WRITE: return entry == null ? mClient.getWritePolicyDefault() : entry.getWritePolicy();
case BATCH: return entry == null ? mClient.getBatchPolicyDefault() : entry.getBatchPolicy();
case SCAN: return entry == null ? mClient.getScanPolicyDefault() : entry.getScanPolicy();
case QUERY: return entry == null ? mClient.getQueryPolicyDefault() : entry.getQueryPolicy();
default: throw new UnsupportedOperationException("Provided unsupported policy.");
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy