org.ehcache.impl.config.executor

Class PooledExecutionServiceConfiguration

java.lang.Object

org.ehcache.impl.config.executor.PooledExecutionServiceConfiguration

All Implemented Interfaces:

org.ehcache.spi.service.ServiceCreationConfiguration<org.ehcache.core.spi.service.ExecutionService,PooledExecutionServiceConfigurationBuilder>

public class PooledExecutionServiceConfiguration
extends java.lang.Object
implements org.ehcache.spi.service.ServiceCreationConfiguration<org.ehcache.core.spi.service.ExecutionService,PooledExecutionServiceConfigurationBuilder>

ServiceCreationConfiguration for the pooled ExecutionService implementation.

Enables configuring named thread pools that can then be used by the different Ehcache services that require threads to function.

See Also:

CacheEventDispatcherFactoryConfiguration, DefaultCacheEventDispatcherConfiguration, WriteBehindProviderConfiguration, DefaultWriteBehindConfiguration, OffHeapDiskStoreProviderConfiguration, OffHeapDiskStoreConfiguration

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PooledExecutionServiceConfiguration.PoolConfiguration Configuration class representing a pool configuration.

Constructor Summary

Constructors

Constructor and Description
PooledExecutionServiceConfiguration()

Method Summary

Modifier and Type	Method and Description
PooledExecutionServiceConfiguration	addDefaultPool(java.lang.String alias, int minSize, int maxSize) Adds a new default pool with the provided minimum and maximum.
PooledExecutionServiceConfiguration	addPool(java.lang.String alias, int minSize, int maxSize) Adds a new pool with the provided minimum and maximum.
PooledExecutionServiceConfiguration	build(PooledExecutionServiceConfigurationBuilder builder)
PooledExecutionServiceConfigurationBuilder	derive()
java.lang.String	getDefaultPoolAlias() Returns the default pool alias, or null if none configured.
java.util.Map<java.lang.String,PooledExecutionServiceConfiguration.PoolConfiguration>	getPoolConfigurations() Returns the map from alias to PooledExecutionServiceConfiguration.PoolConfiguration defined by this configuration object.
java.lang.Class<org.ehcache.core.spi.service.ExecutionService>	getServiceType()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ehcache.spi.service.ServiceCreationConfiguration

compatibleWith

Constructor Detail

PooledExecutionServiceConfiguration

public PooledExecutionServiceConfiguration()

Method Detail

addDefaultPool

public PooledExecutionServiceConfiguration addDefaultPool(java.lang.String alias,
                                                          int minSize,
                                                          int maxSize)

Adds a new default pool with the provided minimum and maximum.

The default pool will be used by any service requiring threads but not specifying a pool alias. It is not mandatory to have a default pool. But without one ALL services have to specify a pool alias.

Parameters:

alias - the pool alias

minSize - the minimum size

maxSize - the maximum size

Returns:

this configuration object with a new default pool

Throws:

java.lang.NullPointerException - if alias is null

java.lang.IllegalArgumentException - if another default was configured already or if another pool with the same alias was configured already

addPool

public PooledExecutionServiceConfiguration addPool(java.lang.String alias,
                                                   int minSize,
                                                   int maxSize)

Adds a new pool with the provided minimum and maximum.

Parameters:

alias - the pool alias

minSize - the minimum size

maxSize - the maximum size

Returns:

this configuration object with a new pool

Throws:

java.lang.NullPointerException - if alias is null

java.lang.IllegalArgumentException - if another pool with the same alias was configured already

getPoolConfigurations

public java.util.Map<java.lang.String,PooledExecutionServiceConfiguration.PoolConfiguration> getPoolConfigurations()

Returns the map from alias to PooledExecutionServiceConfiguration.PoolConfiguration defined by this configuration object.

Returns:

a map from alias to pool configuration

getDefaultPoolAlias

public java.lang.String getDefaultPoolAlias()

Returns the default pool alias, or null if none configured.

Returns:

the default pool alias or null

getServiceType

public java.lang.Class<org.ehcache.core.spi.service.ExecutionService> getServiceType()

Specified by:

getServiceType in interface org.ehcache.spi.service.ServiceCreationConfiguration<org.ehcache.core.spi.service.ExecutionService,PooledExecutionServiceConfigurationBuilder>

derive

public PooledExecutionServiceConfigurationBuilder derive()

Specified by:

derive in interface org.ehcache.spi.service.ServiceCreationConfiguration<org.ehcache.core.spi.service.ExecutionService,PooledExecutionServiceConfigurationBuilder>

build

public PooledExecutionServiceConfiguration build(PooledExecutionServiceConfigurationBuilder builder)

Specified by:

build in interface org.ehcache.spi.service.ServiceCreationConfiguration<org.ehcache.core.spi.service.ExecutionService,PooledExecutionServiceConfigurationBuilder>