CacheContainer (api 0.3.4 API)

java.lang.Object
- org.wildfly.swarm.config.infinispan.CacheContainer

```
public class CacheContainer
extends Object
```
The configuration of an infinispan cache container

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class CacheContainer.CacheContainerResources
Child mutators for CacheContainer

Nested Classes
Modifier and Type	Class and Description
`class`	`CacheContainer.CacheContainerResources` Child mutators for CacheContainer

Constructor Summary

Constructors
Constructor and Description

CacheContainer(String key)

Constructors
Constructor and Description
`CacheContainer(String key)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`aliases()` The list of aliases for this cache container
`CacheContainer`	`aliases(List<String> value)` The list of aliases for this cache container
`AsyncOperationsThreadPool`	`asyncOperationsThreadPool()` Defines a thread pool used for asynchronous operations.
`CacheContainer`	`asyncOperationsThreadPool(AsyncOperationsThreadPool value)` Defines a thread pool used for asynchronous operations.
`String`	`cacheManagerStatus()` The status of the cache manager component.
`CacheContainer`	`cacheManagerStatus(String value)` The status of the cache manager component.
`String`	`clusterName()` The name of the cluster this node belongs to.
`CacheContainer`	`clusterName(String value)` The name of the cluster this node belongs to.
`String`	`coordinatorAddress()` The logical address of the cluster's coordinator.
`CacheContainer`	`coordinatorAddress(String value)` The logical address of the cluster's coordinator.
`String`	`defaultCache()` The default infinispan cache
`CacheContainer`	`defaultCache(String value)` The default infinispan cache
`CacheContainer`	`distributedCache(DistributedCache value)` Add the org.wildfly.swarm.config.infinispan.cache_container.DistributedCache object to the list of subresources
`CacheContainer`	`distributedCaches(List<DistributedCache> value)` Add all org.wildfly.swarm.config.infinispan.cache_container.DistributedCache objects to this subresource
`ExpirationThreadPool`	`expirationThreadPool()` Defines a thread pool used for for evictions.
`CacheContainer`	`expirationThreadPool(ExpirationThreadPool value)` Defines a thread pool used for for evictions.
`String`	`getKey()`
`CacheContainer`	`invalidationCache(InvalidationCache value)` Add the org.wildfly.swarm.config.infinispan.cache_container.InvalidationCache object to the list of subresources
`CacheContainer`	`invalidationCaches(List<InvalidationCache> value)` Add all org.wildfly.swarm.config.infinispan.cache_container.InvalidationCache objects to this subresource
`Boolean`	`isCoordinator()` Set to true if this node is the cluster's coordinator.
`CacheContainer`	`isCoordinator(Boolean value)` Set to true if this node is the cluster's coordinator.
`JgroupsTransport`	`jgroupsTransport()` The description of the transport used by this cache container
`CacheContainer`	`jgroupsTransport(JgroupsTransport value)` The description of the transport used by this cache container
`String`	`jndiName()` The jndi name to which to bind this cache container
`CacheContainer`	`jndiName(String value)` The jndi name to which to bind this cache container
`ListenerThreadPool`	`listenerThreadPool()` Defines a thread pool used for asynchronous cache listener notifications.
`CacheContainer`	`listenerThreadPool(ListenerThreadPool value)` Defines a thread pool used for asynchronous cache listener notifications.
`String`	`localAddress()` The local address of the node.
`CacheContainer`	`localAddress(String value)` The local address of the node.
`CacheContainer`	`localCache(LocalCache value)` Add the org.wildfly.swarm.config.infinispan.cache_container.LocalCache object to the list of subresources
`CacheContainer`	`localCaches(List<LocalCache> value)` Add all org.wildfly.swarm.config.infinispan.cache_container.LocalCache objects to this subresource
`String`	`module()` The module whose class loader should be used when building this cache container's configuration.
`CacheContainer`	`module(String value)` The module whose class loader should be used when building this cache container's configuration.
`NoneTransport`	`noneTransport()` A local-only transport used by this cache-container
`CacheContainer`	`noneTransport(NoneTransport value)` A local-only transport used by this cache-container
`PersistenceThreadPool`	`persistenceThreadPool()` Defines a thread pool used for interacting with the persistent store.
`CacheContainer`	`persistenceThreadPool(PersistenceThreadPool value)` Defines a thread pool used for interacting with the persistent store.
`RemoteCommandThreadPool`	`remoteCommandThreadPool()` Defines a thread pool used to execute remote commands.
`CacheContainer`	`remoteCommandThreadPool(RemoteCommandThreadPool value)` Defines a thread pool used to execute remote commands.
`CacheContainer`	`replicatedCache(ReplicatedCache value)` Add the org.wildfly.swarm.config.infinispan.cache_container.ReplicatedCache object to the list of subresources
`CacheContainer`	`replicatedCaches(List<ReplicatedCache> value)` Add all org.wildfly.swarm.config.infinispan.cache_container.ReplicatedCache objects to this subresource
`StateTransferThreadPool`	`stateTransferThreadPool()` Defines a thread pool used for for state transfer.
`CacheContainer`	`stateTransferThreadPool(StateTransferThreadPool value)` Defines a thread pool used for for state transfer.
`Boolean`	`statisticsEnabled()` If enabled, statistics will be collected for this cache container
`CacheContainer`	`statisticsEnabled(Boolean value)` If enabled, statistics will be collected for this cache container
`CacheContainer.CacheContainerResources`	`subresources()`
`TransportThreadPool`	`transportThreadPool()` Defines a thread pool used for asynchronous transport communication.
`CacheContainer`	`transportThreadPool(TransportThreadPool value)` Defines a thread pool used for asynchronous transport communication.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CacheContainer
```
public CacheContainer(String key)
```
- Method Detail
  - getKey
```
public String getKey()
```
  - aliases
```
public List<String> aliases()
```
    The list of aliases for this cache container
  - aliases
```
public CacheContainer aliases(List<String> value)
```
    The list of aliases for this cache container
  - cacheManagerStatus
```
public String cacheManagerStatus()
```
    The status of the cache manager component. May return null if the cache manager is not started.
  - cacheManagerStatus
```
public CacheContainer cacheManagerStatus(String value)
```
    The status of the cache manager component. May return null if the cache manager is not started.
  - clusterName
```
public String clusterName()
```
    The name of the cluster this node belongs to. May return null if the cache manager is not started.
  - clusterName
```
public CacheContainer clusterName(String value)
```
    The name of the cluster this node belongs to. May return null if the cache manager is not started.
  - coordinatorAddress
```
public String coordinatorAddress()
```
    The logical address of the cluster's coordinator. May return null if the cache manager is not started.
  - coordinatorAddress
```
public CacheContainer coordinatorAddress(String value)
```
    The logical address of the cluster's coordinator. May return null if the cache manager is not started.
  - defaultCache
```
public String defaultCache()
```
    The default infinispan cache
  - defaultCache
```
public CacheContainer defaultCache(String value)
```
    The default infinispan cache
  - isCoordinator
```
public Boolean isCoordinator()
```
    Set to true if this node is the cluster's coordinator. May return null if the cache manager is not started.
  - isCoordinator
```
public CacheContainer isCoordinator(Boolean value)
```
    Set to true if this node is the cluster's coordinator. May return null if the cache manager is not started.
  - jndiName
```
public String jndiName()
```
    The jndi name to which to bind this cache container
  - jndiName
```
public CacheContainer jndiName(String value)
```
    The jndi name to which to bind this cache container
  - localAddress
```
public String localAddress()
```
    The local address of the node. May return null if the cache manager is not started.
  - localAddress
```
public CacheContainer localAddress(String value)
```
    The local address of the node. May return null if the cache manager is not started.
  - module
```
public String module()
```
    The module whose class loader should be used when building this cache container's configuration.
  - module
```
public CacheContainer module(String value)
```
    The module whose class loader should be used when building this cache container's configuration.
  - statisticsEnabled
```
public Boolean statisticsEnabled()
```
    If enabled, statistics will be collected for this cache container
  - statisticsEnabled
```
public CacheContainer statisticsEnabled(Boolean value)
```
    If enabled, statistics will be collected for this cache container
  - subresources
```
public CacheContainer.CacheContainerResources subresources()
```
  - invalidationCaches
```
public CacheContainer invalidationCaches(List<InvalidationCache> value)
```
    Add all org.wildfly.swarm.config.infinispan.cache_container.InvalidationCache objects to this subresource
    
    Parameters:
    
    value - List of org.wildfly.swarm.config.infinispan.cache_container.InvalidationCache objects.
    
    Returns:
    
    this
  - invalidationCache
```
public CacheContainer invalidationCache(InvalidationCache value)
```
    Add the org.wildfly.swarm.config.infinispan.cache_container.InvalidationCache object to the list of subresources
    
    Parameters:
    
    value - The org.wildfly.swarm.config.infinispan.cache_container.InvalidationCache to add
    
    Returns:
    
    this
  - localCaches
```
public CacheContainer localCaches(List<LocalCache> value)
```
    Add all org.wildfly.swarm.config.infinispan.cache_container.LocalCache objects to this subresource
    
    Parameters:
    
    value - List of org.wildfly.swarm.config.infinispan.cache_container.LocalCache objects.
    
    Returns:
    
    this
  - localCache
```
public CacheContainer localCache(LocalCache value)
```
    Add the org.wildfly.swarm.config.infinispan.cache_container.LocalCache object to the list of subresources
    
    Parameters:
    
    value - The org.wildfly.swarm.config.infinispan.cache_container.LocalCache to add
    
    Returns:
    
    this
  - replicatedCaches
```
public CacheContainer replicatedCaches(List<ReplicatedCache> value)
```
    Add all org.wildfly.swarm.config.infinispan.cache_container.ReplicatedCache objects to this subresource
    
    Parameters:
    
    value - List of org.wildfly.swarm.config.infinispan.cache_container.ReplicatedCache objects.
    
    Returns:
    
    this
  - replicatedCache
```
public CacheContainer replicatedCache(ReplicatedCache value)
```
    Add the org.wildfly.swarm.config.infinispan.cache_container.ReplicatedCache object to the list of subresources
    
    Parameters:
    
    value - The org.wildfly.swarm.config.infinispan.cache_container.ReplicatedCache to add
    
    Returns:
    
    this
  - distributedCaches
```
public CacheContainer distributedCaches(List<DistributedCache> value)
```
    Add all org.wildfly.swarm.config.infinispan.cache_container.DistributedCache objects to this subresource
    
    Parameters:
    
    value - List of org.wildfly.swarm.config.infinispan.cache_container.DistributedCache objects.
    
    Returns:
    
    this
  - distributedCache
```
public CacheContainer distributedCache(DistributedCache value)
```
    Add the org.wildfly.swarm.config.infinispan.cache_container.DistributedCache object to the list of subresources
    
    Parameters:
    
    value - The org.wildfly.swarm.config.infinispan.cache_container.DistributedCache to add
    
    Returns:
    
    this
  - jgroupsTransport
```
public JgroupsTransport jgroupsTransport()
```
    The description of the transport used by this cache container
  - jgroupsTransport
```
public CacheContainer jgroupsTransport(JgroupsTransport value)
```
    The description of the transport used by this cache container
  - remoteCommandThreadPool
```
public RemoteCommandThreadPool remoteCommandThreadPool()
```
    Defines a thread pool used to execute remote commands.
  - remoteCommandThreadPool
```
public CacheContainer remoteCommandThreadPool(RemoteCommandThreadPool value)
```
    Defines a thread pool used to execute remote commands.
  - asyncOperationsThreadPool
```
public AsyncOperationsThreadPool asyncOperationsThreadPool()
```
    Defines a thread pool used for asynchronous operations.
  - asyncOperationsThreadPool
```
public CacheContainer asyncOperationsThreadPool(AsyncOperationsThreadPool value)
```
    Defines a thread pool used for asynchronous operations.
  - expirationThreadPool
```
public ExpirationThreadPool expirationThreadPool()
```
    Defines a thread pool used for for evictions.
  - expirationThreadPool
```
public CacheContainer expirationThreadPool(ExpirationThreadPool value)
```
    Defines a thread pool used for for evictions.
  - noneTransport
```
public NoneTransport noneTransport()
```
    A local-only transport used by this cache-container
  - noneTransport
```
public CacheContainer noneTransport(NoneTransport value)
```
    A local-only transport used by this cache-container
  - transportThreadPool
```
public TransportThreadPool transportThreadPool()
```
    Defines a thread pool used for asynchronous transport communication.
  - transportThreadPool
```
public CacheContainer transportThreadPool(TransportThreadPool value)
```
    Defines a thread pool used for asynchronous transport communication.
  - persistenceThreadPool
```
public PersistenceThreadPool persistenceThreadPool()
```
    Defines a thread pool used for interacting with the persistent store.
  - persistenceThreadPool
```
public CacheContainer persistenceThreadPool(PersistenceThreadPool value)
```
    Defines a thread pool used for interacting with the persistent store.
  - listenerThreadPool
```
public ListenerThreadPool listenerThreadPool()
```
    Defines a thread pool used for asynchronous cache listener notifications.
  - listenerThreadPool
```
public CacheContainer listenerThreadPool(ListenerThreadPool value)
```
    Defines a thread pool used for asynchronous cache listener notifications.
  - stateTransferThreadPool
```
public StateTransferThreadPool stateTransferThreadPool()
```
    Defines a thread pool used for for state transfer.
  - stateTransferThreadPool
```
public CacheContainer stateTransferThreadPool(StateTransferThreadPool value)
```
    Defines a thread pool used for for state transfer.

Class CacheContainer

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CacheContainer

Method Detail

getKey

aliases

aliases

cacheManagerStatus

cacheManagerStatus

clusterName

clusterName

coordinatorAddress

coordinatorAddress

defaultCache

defaultCache

isCoordinator

isCoordinator

jndiName

jndiName

localAddress

localAddress

module

module

statisticsEnabled

statisticsEnabled

subresources

invalidationCaches

invalidationCache

localCaches

localCache

replicatedCaches

replicatedCache

distributedCaches

distributedCache

jgroupsTransport

jgroupsTransport

remoteCommandThreadPool

remoteCommandThreadPool

asyncOperationsThreadPool

asyncOperationsThreadPool

expirationThreadPool

expirationThreadPool

noneTransport

noneTransport

transportThreadPool

transportThreadPool

persistenceThreadPool

persistenceThreadPool

listenerThreadPool

listenerThreadPool

stateTransferThreadPool

stateTransferThreadPool