package org.infinispan.configuration.global;
import org.infinispan.Version;
import org.infinispan.commons.CacheConfigurationException;
import org.infinispan.commons.configuration.Builder;
import org.infinispan.commons.marshall.AdvancedExternalizer;
import org.infinispan.commons.marshall.Marshaller;
import org.infinispan.marshall.LegacyAdvancedExternalizerAdapter;
import org.infinispan.marshall.core.VersionAwareMarshaller;
import org.jboss.marshalling.ClassResolver;
import java.util.HashMap;
import java.util.Map;
/**
* Configures serialization and marshalling settings.
*/
public class SerializationConfigurationBuilder extends AbstractGlobalConfigurationBuilder implements Builder<SerializationConfiguration> {
private Marshaller marshaller = new VersionAwareMarshaller();
private short marshallVersion = Short.valueOf(Version.MAJOR_MINOR.replace(".", ""));
private Map<Integer, AdvancedExternalizer<?>> advancedExternalizers = new HashMap<Integer, AdvancedExternalizer<?>>();
private ClassResolver classResolver;
SerializationConfigurationBuilder(GlobalConfigurationBuilder globalConfig) {
super(globalConfig);
}
/**
* Set the marshaller instance that will marshall and unmarshall cache entries.
*
* @param marshaller
*/
public SerializationConfigurationBuilder marshaller(Marshaller marshaller) {
this.marshaller = marshaller;
return this;
}
/**
* Largest allowable version to use when marshalling internal state. Set this to the lowest version cache instance in
* your cluster to ensure compatibility of communications. However, setting this too low will mean you lose out on
* the benefit of improvements in newer versions of the marshaller.
*
* @param marshallVersion
*/
public SerializationConfigurationBuilder version(short marshallVersion) {
this.marshallVersion = marshallVersion;
return this;
}
/**
* Largest allowable version to use when marshalling internal state. Set this to the lowest version cache instance in
* your cluster to ensure compatibility of communications. However, setting this too low will mean you lose out on
* the benefit of improvements in newer versions of the marshaller.
*
* @param marshallVersion
*/
public SerializationConfigurationBuilder version(String marshallVersion) {
this.marshallVersion = Version.getVersionShort(marshallVersion);
return this;
}
/**
* Helper method that allows for quick registration of an {@link org.infinispan.marshall.AdvancedExternalizer}
* implementation alongside its corresponding identifier. Remember that the identifier needs to a be positive number,
* including 0, and cannot clash with other identifiers in the system.
*
* @param id
* @param advancedExternalizer
*/
public <T> SerializationConfigurationBuilder addAdvancedExternalizer(int id, AdvancedExternalizer<T> advancedExternalizer) {
AdvancedExternalizer<?> ext = advancedExternalizers.get(id);
if (ext != null)
throw new CacheConfigurationException(String.format(
"Duplicate externalizer id found! Externalizer id=%d for %s is shared by another externalizer (%s)",
id, advancedExternalizer.getClass().getName(), ext.getClass().getName()));
advancedExternalizers.put(id, advancedExternalizer);
return this;
}
/**
* This method provides compatibility with legacy {@link org.infinispan.marshall.AdvancedExternalizer}. Please migrate to {@link AdvancedExternalizer}
*
* @param id
* @param advancedExternalizer
*/
@Deprecated
public <T> SerializationConfigurationBuilder addAdvancedExternalizer(int id, org.infinispan.marshall.AdvancedExternalizer<T> advancedExternalizer) {
AdvancedExternalizer<?> ext = advancedExternalizers.get(id);
if (ext != null)
throw new CacheConfigurationException(String.format(
"Duplicate externalizer id found! Externalizer id=%d for %s is shared by another externalizer (%s)",
id, advancedExternalizer.getClass().getName(), ext.getClass().getName()));
advancedExternalizers.put(id, new LegacyAdvancedExternalizerAdapter(advancedExternalizer));
return this;
}
/**
* Helper method that allows for quick registration of an {@link org.infinispan.marshall.AdvancedExternalizer}
* implementation alongside its corresponding identifier. Remember that the identifier needs to a be positive number,
* including 0, and cannot clash with other identifiers in the system.
*
* @param advancedExternalizer
*/
public <T> SerializationConfigurationBuilder addAdvancedExternalizer(AdvancedExternalizer<T> advancedExternalizer) {
Integer id = advancedExternalizer.getId();
if (id == null)
throw new CacheConfigurationException(String.format(
"No advanced externalizer identifier set for externalizer %s",
advancedExternalizer.getClass().getName()));
this.addAdvancedExternalizer(id.intValue(), advancedExternalizer);
return this;
}
/**
* This method provides compatibility with legacy {@link org.infinispan.marshall.AdvancedExternalizer}. Please migrate to {@link AdvancedExternalizer}
*
* @param advancedExternalizer
*/
public <T> SerializationConfigurationBuilder addAdvancedExternalizer(org.infinispan.marshall.AdvancedExternalizer<T> advancedExternalizer) {
Integer id = advancedExternalizer.getId();
if (id == null)
throw new CacheConfigurationException(String.format(
"No advanced externalizer identifier set for externalizer %s",
advancedExternalizer.getClass().getName()));
this.addAdvancedExternalizer(id.intValue(), advancedExternalizer);
return this;
}
/**
* Helper method that allows for quick registration of {@link org.infinispan.marshall.AdvancedExternalizer}
* implementations.
*
* @param advancedExternalizers
*/
public <T> SerializationConfigurationBuilder addAdvancedExternalizer(AdvancedExternalizer<T>... advancedExternalizers) {
for (AdvancedExternalizer<T> advancedExternalizer : advancedExternalizers) {
this.addAdvancedExternalizer(advancedExternalizer);
}
return this;
}
/**
* This method provides compatibility with legacy {@link org.infinispan.marshall.AdvancedExternalizer}. Please migrate to {@link AdvancedExternalizer}
*
* @param advancedExternalizers
*/
public <T> SerializationConfigurationBuilder addAdvancedExternalizer(org.infinispan.marshall.AdvancedExternalizer<T>... advancedExternalizers) {
for (org.infinispan.marshall.AdvancedExternalizer<T> advancedExternalizer : advancedExternalizers) {
this.addAdvancedExternalizer(advancedExternalizer);
}
return this;
}
/**
* Class resolver to use when unmarshallig objects.
*
* @param classResolver
*/
public SerializationConfigurationBuilder classResolver(ClassResolver classResolver) {
this.classResolver = classResolver;
return this;
}
@Override
public void validate() {
// No-op, no validation required
}
@Override
public
SerializationConfiguration create() {
return new SerializationConfiguration(
marshaller, marshallVersion, advancedExternalizers, classResolver);
}
@Override
public
SerializationConfigurationBuilder read(SerializationConfiguration template) {
this.advancedExternalizers = template.advancedExternalizers();
this.marshaller = template.marshaller();
this.marshallVersion = template.version();
this.classResolver = template.classResolver();
return this;
}
@Override
public String toString() {
return "SerializationConfigurationBuilder{" +
"advancedExternalizers=" + advancedExternalizers +
", marshaller=" + marshaller +
", marshallVersion=" + marshallVersion +
", classResolver=" + classResolver +
'}';
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
SerializationConfigurationBuilder that = (SerializationConfigurationBuilder) o;
if (marshallVersion != that.marshallVersion) return false;
if (advancedExternalizers != null ? !advancedExternalizers.equals(that.advancedExternalizers) : that.advancedExternalizers != null)
return false;
if (marshaller != null ? !marshaller.equals(that.marshaller) : that.marshaller != null)
return false;
if (classResolver != null ? !classResolver.equals(that.classResolver) : that.classResolver != null)
return false;
return true;
}
@Override
public int hashCode() {
int result = marshaller != null ? marshaller.hashCode() : 0;
result = 31 * result + marshallVersion;
result = 31 * result + (advancedExternalizers != null ? advancedExternalizers.hashCode() : 0);
result = 31 * result + (classResolver != null ? classResolver.hashCode() : 0);
return result;
}
}