org.infinispan.configuration.cache.SingletonStoreConfiguration Maven / Gradle / Ivy
package org.infinispan.configuration.cache;
import java.util.concurrent.TimeUnit;
import org.infinispan.commons.configuration.attributes.Attribute;
import org.infinispan.commons.configuration.attributes.AttributeDefinition;
import org.infinispan.commons.configuration.attributes.AttributeSet;
/**
* SingletonStore is a delegating cache store used for situations when only one instance in a
* cluster should interact with the underlying store. The coordinator of the cluster will be
* responsible for the underlying CacheStore. SingletonStore is a simply facade to a real CacheStore
* implementation. It always delegates reads to the real CacheStore.
*
* @author pmuir
*
*/
public class SingletonStoreConfiguration {
final static AttributeDefinition ENABLED = AttributeDefinition.builder("enabled", false).immutable().build();
final static AttributeDefinition PUSH_STATE_TIMEOUT = AttributeDefinition.builder("pushStateTimeout", TimeUnit.SECONDS.toMillis(10)).immutable().build();
final static AttributeDefinition PUSH_STATE_WHEN_COORDINATOR = AttributeDefinition.builder("pushStateWhenCoordinator", true).immutable().build();
static AttributeSet attributeDefinitionSet() {
return new AttributeSet(SingletonStoreConfiguration.class, ENABLED, PUSH_STATE_TIMEOUT, PUSH_STATE_WHEN_COORDINATOR);
}
private final Attribute enabled;
private final Attribute pushStateTimeout;
private final Attribute pushStateWhenCoordinator;
private final AttributeSet attributes;
SingletonStoreConfiguration(AttributeSet attributes) {
this.attributes = attributes.checkProtection();
enabled = attributes.attribute(ENABLED);
pushStateTimeout = attributes.attribute(PUSH_STATE_TIMEOUT);
pushStateWhenCoordinator = attributes.attribute(PUSH_STATE_WHEN_COORDINATOR);
}
/**
* If true, the singleton store cache store is enabled.
*/
public boolean enabled() {
return enabled.get();
}
/**
* If pushStateWhenCoordinator is true, this property sets the maximum number of milliseconds
* that the process of pushing the in-memory state to the underlying cache loader should take.
*/
public long pushStateTimeout() {
return pushStateTimeout.get();
}
/**
* If true, when a node becomes the coordinator, it will transfer in-memory state to the
* underlying cache store. This can be very useful in situations where the coordinator crashes
* and there's a gap in time until the new coordinator is elected.
*/
public boolean pushStateWhenCoordinator() {
return pushStateWhenCoordinator.get();
}
public AttributeSet attributes() {
return attributes;
}
@Override
public String toString() {
return "SingletonStoreConfiguration [attributes=" + attributes + "]";
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((attributes == null) ? 0 : attributes.hashCode());
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
SingletonStoreConfiguration other = (SingletonStoreConfiguration) obj;
if (attributes == null) {
if (other.attributes != null)
return false;
} else if (!attributes.equals(other.attributes))
return false;
return true;
}
}