MCMPHandlerConfigurationBuilder (mod_cluster (parent) 1.4.5.Final API)

java.lang.Object
- org.jboss.modcluster.config.builder.MCMPHandlerConfigurationBuilder

All Implemented Interfaces:

ConfigurationBuilder, Creator<MCMPHandlerConfiguration>
```
public class MCMPHandlerConfigurationBuilder
extends Object
implements Creator<MCMPHandlerConfiguration>
```
Builder for MCMP (Mod-Cluster Management Protocol) handler configuration.

Since:

1.3.6.Final

Author:

Radoslav Husar

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdvertiseConfigurationBuilder`	`advertise()` Builder for multicast-based advertise configuration.
`BalancerConfigurationBuilder`	`balancer()` Builder for balancer configuration.
`ModClusterConfiguration`	`build()` Builds the main configuration object.
`MCMPHandlerConfiguration`	`create()` Creates the configuration object.
`MCMPHandlerConfigurationBuilder`	`mcmp()` Builder for MCMP (Mod-Cluster Management Protocol) handler configuration.
`NodeConfigurationBuilder`	`node()` Builder for proxy node configuration.
`MCMPHandlerConfigurationBuilder`	`setAdvertise(Boolean advertise)` Sets whether to receive advertisements from httpd proxies.
`MCMPHandlerConfigurationBuilder`	`setAutoEnableContexts(boolean autoEnableContexts)` Sets whether or not to automatically enable contexts.
`MCMPHandlerConfigurationBuilder`	`setExcludedContextsPerHost(Map<String,Set<String>> excludedContextsPerHost)` Sets a map of contexts per host that should never be registered by mod_cluster with the proxy.
`MCMPHandlerConfigurationBuilder`	`setJvmRouteFactory(JvmRouteFactory jvmRouteFactory)` Sets a factory for generating a JVM route.
`MCMPHandlerConfigurationBuilder`	`setProxyConfigurations(Collection<ProxyConfiguration> proxyConfigurations)` Sets a static list of proxies to register with as a collection of `ProxyConfiguration`s.
`MCMPHandlerConfigurationBuilder`	`setProxyURL(String proxyURL)` Sets URL prefix to send with commands to mod_cluster.
`MCMPHandlerConfigurationBuilder`	`setSessionDrainingStrategy(SessionDrainingStrategy sessionDrainingStrategy)` Configures the strategy for draining sessions from a context.
`MCMPHandlerConfigurationBuilder`	`setSocketFactory(SocketFactory socketFactory)` Sets socket factory for communication with the proxy; supply an SSL socket factory to use SSL to connect to the proxy.
`MCMPHandlerConfigurationBuilder`	`setSocketTimeout(int socketTimeout)` Sets connection timeout for communication with the proxy.
`MCMPHandlerConfigurationBuilder`	`setStopContextTimeout(long stopContextTimeout)` Sets the number of `setStopContextTimeoutUnit(TimeUnit)` to wait for pending requests to complete when stopping a context.
`MCMPHandlerConfigurationBuilder`	`setStopContextTimeoutUnit(TimeUnit stopContextTimeoutUnit)` Sets the unit of time to which `setStopContextTimeout(long)` pertains.

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

- Method Detail
  - setProxyConfigurations
```
public MCMPHandlerConfigurationBuilder setProxyConfigurations(Collection<ProxyConfiguration> proxyConfigurations)
```
    Sets a static list of proxies to register with as a collection of ProxyConfigurations.
  - setProxyURL
```
public MCMPHandlerConfigurationBuilder setProxyURL(String proxyURL)
```
    Sets URL prefix to send with commands to mod_cluster. Default is no prefix.
  - setSocketTimeout
```
public MCMPHandlerConfigurationBuilder setSocketTimeout(int socketTimeout)
```
    Sets connection timeout for communication with the proxy.
  - setSocketFactory
```
public MCMPHandlerConfigurationBuilder setSocketFactory(SocketFactory socketFactory)
```
    Sets socket factory for communication with the proxy; supply an SSL socket factory to use SSL to connect to the proxy.
  - setExcludedContextsPerHost
```
public MCMPHandlerConfigurationBuilder setExcludedContextsPerHost(Map<String,Set<String>> excludedContextsPerHost)
```
    Sets a map of contexts per host that should never be registered by mod_cluster with the proxy.
  - setAdvertise
```
public MCMPHandlerConfigurationBuilder setAdvertise(Boolean advertise)
```
    Sets whether to receive advertisements from httpd proxies.
  - setAutoEnableContexts
```
public MCMPHandlerConfigurationBuilder setAutoEnableContexts(boolean autoEnableContexts)
```
    Sets whether or not to automatically enable contexts. If false, context will need to be enabled manually.
  - setStopContextTimeout
```
public MCMPHandlerConfigurationBuilder setStopContextTimeout(long stopContextTimeout)
```
    Sets the number of setStopContextTimeoutUnit(TimeUnit) to wait for pending requests to complete when stopping a context.
  - setStopContextTimeoutUnit
```
public MCMPHandlerConfigurationBuilder setStopContextTimeoutUnit(TimeUnit stopContextTimeoutUnit)
```
    Sets the unit of time to which setStopContextTimeout(long) pertains.
  - setJvmRouteFactory
```
public MCMPHandlerConfigurationBuilder setJvmRouteFactory(JvmRouteFactory jvmRouteFactory)
```
    Sets a factory for generating a JVM route.
  - setSessionDrainingStrategy
```
public MCMPHandlerConfigurationBuilder setSessionDrainingStrategy(SessionDrainingStrategy sessionDrainingStrategy)
```
    Configures the strategy for draining sessions from a context.
  - create
```
public MCMPHandlerConfiguration create()
```
    Description copied from interface: Creator
    
    Creates the configuration object.
    
    Specified by:
    
    create in interface Creator<MCMPHandlerConfiguration>
  - advertise
```
public AdvertiseConfigurationBuilder advertise()
```
    Description copied from interface: ConfigurationBuilder
    
    Builder for multicast-based advertise configuration.
    
    Specified by:
    
    advertise in interface ConfigurationBuilder
  - balancer
```
public BalancerConfigurationBuilder balancer()
```
    Description copied from interface: ConfigurationBuilder
    
    Builder for balancer configuration.
    
    Specified by:
    
    balancer in interface ConfigurationBuilder
  - node
```
public NodeConfigurationBuilder node()
```
    Description copied from interface: ConfigurationBuilder
    
    Builder for proxy node configuration.
    
    Specified by:
    
    node in interface ConfigurationBuilder
  - mcmp
```
public MCMPHandlerConfigurationBuilder mcmp()
```
    Description copied from interface: ConfigurationBuilder
    
    Builder for MCMP (Mod-Cluster Management Protocol) handler configuration.
    
    Specified by:
    
    mcmp in interface ConfigurationBuilder
  - build
```
public ModClusterConfiguration build()
```
    Description copied from interface: ConfigurationBuilder
    
    Builds the main configuration object.
    
    Specified by:
    
    build in interface ConfigurationBuilder

Class MCMPHandlerConfigurationBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setProxyConfigurations

setProxyURL

setSocketTimeout

setSocketFactory

setExcludedContextsPerHost

setAdvertise

setAutoEnableContexts

setStopContextTimeout

setStopContextTimeoutUnit

setJvmRouteFactory

setSessionDrainingStrategy

create

advertise

balancer

node

mcmp

build