ehcache-core 2.10.9.2 · net.sf.ehcache.config.TerracottaClientConfiguration

Modifier and Type	Field and Description
private volatile boolean	configFrozen
public static final boolean	DEFAULT_REJOIN_VALUE Default value of rejoin attribute
public static final boolean	DEFAULT_WAN_ENABLED_TSA_VALUE Default value for whether WAN replication enabled or not
private String	embeddedConfig
private boolean	rejoin
private static final String	TC_CONFIG_FOOTER
private static final String	TC_CONFIG_HEADER
private String	url
private boolean	wanEnabledTSA

Access	Constructor and Description
public	TerracottaClientConfiguration()

Method Summary

Modifier and Type	Method and Description
public TerracottaClientConfiguration	Returns: a copy, which independent other than configurations than cannot change. clone() Overrides java.lang.Object.clone. Clones this object, following the usual contract.
public final void	extractTcconfig(String text) Tell the BeanHandler to extract the entire subtree xml as text at element`<tc-config/>`.
public void	freezeConfig() Freezes the config
public final String	getEmbeddedConfig() Get the embedded config read as `<tc-config/>`
public final String	Returns: original embedded config getOriginalEmbeddedConfig() Get the original embedded config
public final String	getUrl() Get url string
public boolean	Returns: the rejoin isRejoin() Returns true if rejoin is enabled
public final boolean	isUrlConfig() Helper to check whether this is url config or embedded config
public boolean	Returns: wanEnabledTSA isWanEnabledTSA() Returns true if it is a WAN enabled TSA
public TerracottaClientConfiguration	Returns: this instance rejoin(boolean rejoin) Builder method to set rejoin
public void	setRejoin(boolean the rejoin to set rejoin) Set rejoin value
public final void	setUrl(String url) Set url
public void	setWanEnabledTSA(boolean wanEnabledTSA) Set wanEnabledTSA value
public final TerracottaClientConfiguration	Returns: this configuration instance url(String the URL to set url) Builder method to set the URL.
public final TerracottaClientConfiguration	Returns: this configuration instance url(String the host where to get the Terracotta configuration from host, String the port on that host port) Builder method to set the URL for a host and a port.
private void	validateConfiguration()
public TerracottaClientConfiguration	Returns: this instance wanEnabledTSA(boolean wanEnabledTSA) Builder method to set wanEnabledTSA

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

configFrozen	back to summary
private volatile boolean configFrozen

DEFAULT_REJOIN_VALUE	back to summary
public static final boolean DEFAULT_REJOIN_VALUE Default value of rejoin attribute

DEFAULT_WAN_ENABLED_TSA_VALUE	back to summary
public static final boolean DEFAULT_WAN_ENABLED_TSA_VALUE Default value for whether WAN replication enabled or not

embeddedConfig	back to summary
private String embeddedConfig

rejoin	back to summary
private boolean rejoin

TC_CONFIG_FOOTER	back to summary
private static final String TC_CONFIG_FOOTER

TC_CONFIG_HEADER	back to summary
private static final String TC_CONFIG_HEADER

url	back to summary
private String url

wanEnabledTSA	back to summary
private boolean wanEnabledTSA

TerracottaClientConfiguration	back to summary
public TerracottaClientConfiguration()

Method Detail

clone back to summary

clone	back to summary
public TerracottaClientConfiguration clone() throws CloneNotSupportedException Overrides java.lang.Object.clone. Clones this object, following the usual contract. Returns:TerracottaClientConfiguration a copy, which independent other than configurations than cannot change. Annotations @Override Exceptions CloneNotSupportedException: Doc from java.lang.Object.clone. if the object's class does not support the `Cloneable` interface. Subclasses that override the `clone` method can also throw this exception to indicate that an instance cannot be cloned.

public TerracottaClientConfiguration clone() throws CloneNotSupportedException

Overrides java.lang.Object.clone.

Clones this object, following the usual contract.

Returns:TerracottaClientConfiguration

a copy, which independent other than configurations than cannot change.

Annotations

@Override

Exceptions

CloneNotSupportedException:

Doc from java.lang.Object.clone.

if the object's class does not support the Cloneable interface. Subclasses that override the clone method can also throw this exception to indicate that an instance cannot be cloned.

extractTcconfig	back to summary
public final void extractTcconfig(String text) Tell the BeanHandler to extract the entire subtree xml as text at element`<tc-config/>`. Expects to receive the contents of the`<tc-config/>` tag and will wrap it in a proper tc-config header / footer.

freezeConfig	back to summary
public void freezeConfig() Freezes the config

getEmbeddedConfig	back to summary
public final String getEmbeddedConfig() Get the embedded config read as `<tc-config/>`

getOriginalEmbeddedConfig	back to summary
public final String getOriginalEmbeddedConfig() Get the original embedded config Returns:String original embedded config

getOriginalEmbeddedConfig

back to summary

public final String getOriginalEmbeddedConfig()

Get the original embedded config

Returns:String: original embedded config

getUrl	back to summary
public final String getUrl() Get url string

isRejoin	back to summary
public boolean isRejoin() Returns true if rejoin is enabled Returns:boolean the rejoin

isRejoin

back to summary

public boolean isRejoin()

Returns true if rejoin is enabled

Returns:boolean: the rejoin

isUrlConfig	back to summary
public final boolean isUrlConfig() Helper to check whether this is url config or embedded config

isWanEnabledTSA	back to summary
public boolean isWanEnabledTSA() Returns true if it is a WAN enabled TSA Returns:boolean wanEnabledTSA

isWanEnabledTSA

back to summary

public boolean isWanEnabledTSA()

Returns true if it is a WAN enabled TSA

Returns:boolean: wanEnabledTSA

rejoin	back to summary
public TerracottaClientConfiguration rejoin(boolean rejoin) Builder method to set rejoin Returns:TerracottaClientConfiguration this instance

rejoin

back to summary

public TerracottaClientConfiguration rejoin(boolean rejoin)

Builder method to set rejoin

Returns:TerracottaClientConfiguration: this instance

setRejoin	back to summary
public void setRejoin(boolean rejoin) Set rejoin value Parameters rejoin:boolean the rejoin to set

setRejoin

back to summary

public void setRejoin(boolean rejoin)

Set rejoin value

Parameters

rejoin:boolean: the rejoin to set

setUrl	back to summary
public final void setUrl(String url) Set url

setWanEnabledTSA	back to summary
public void setWanEnabledTSA(boolean wanEnabledTSA) Set wanEnabledTSA value

url	back to summary
public final TerracottaClientConfiguration url(String url) Builder method to set the URL. Parameters url:String the URL to set Returns:TerracottaClientConfiguration this configuration instance

url

back to summary

public final TerracottaClientConfiguration url(String url)

Builder method to set the URL.

Parameters

url:String: the URL to set

Returns:TerracottaClientConfiguration

this configuration instance

url	back to summary
public final TerracottaClientConfiguration url(String host, String port) Builder method to set the URL for a host and a port. Parameters host:String the host where to get the Terracotta configuration from port:String the port on that host Returns:TerracottaClientConfiguration this configuration instance

url

back to summary

public final TerracottaClientConfiguration url(String host, String port)

Builder method to set the URL for a host and a port.

Parameters

host:String: the host where to get the Terracotta configuration from
port:String: the port on that host

Returns:TerracottaClientConfiguration

this configuration instance

validateConfiguration	back to summary
private void validateConfiguration()

wanEnabledTSA	back to summary
public TerracottaClientConfiguration wanEnabledTSA(boolean wanEnabledTSA) Builder method to set wanEnabledTSA Returns:TerracottaClientConfiguration this instance

wanEnabledTSA

back to summary

public TerracottaClientConfiguration wanEnabledTSA(boolean wanEnabledTSA)

Builder method to set wanEnabledTSA

Returns:TerracottaClientConfiguration: this instance

public Class TerracottaClientConfiguration

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail