Package com.tangosol.net

Class CoherenceConfiguration.Builder

java.lang.Object

com.tangosol.net.CoherenceConfiguration.Builder

Enclosing interface:

CoherenceConfiguration

public static class CoherenceConfiguration.Builder
extends Object

A builder to build a CoherenceConfiguration instance.

This class is not thread-safe, application code that calls methods on this builder from multiple threads must implement its own thread-safety.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CoherenceConfiguration	build()	Build a CoherenceConfiguration from this CoherenceConfiguration.Builder.
CoherenceConfiguration.Builder	discoverSessions()	Add all of the SessionConfiguration instances discovered using the ServiceLoader.
CoherenceConfiguration.Builder	named(String sName)	Set the name of the Coherence instance.
CoherenceConfiguration.Builder	withApplicationContext(com.tangosol.application.Context context)	Set the application context to associate to the Coherence instance.
CoherenceConfiguration.Builder	withDefaultSession(String sName)	Set the name of the Session to return is a Session is requested with the default name.
CoherenceConfiguration.Builder	withEventInterceptor(EventInterceptor<?> interceptor)	Add an EventInterceptor that will be added to all Session instances as they are created on start-up.
CoherenceConfiguration.Builder	withEventInterceptors(EventInterceptor<?>... interceptors)	Add the EventInterceptor instances that will be added to all Session instances as they are created on start-up.
CoherenceConfiguration.Builder	withEventInterceptors(Iterable<? extends EventInterceptor<?>> interceptors)	Add the EventInterceptor instances that will be added to all Session instances as they are created on start-up.
CoherenceConfiguration.Builder	withSession(SessionConfiguration config)	Add a SessionConfiguration to the Coherence instance that will be used to create the corresponding Session on start-up.
CoherenceConfiguration.Builder	withSessions(SessionConfiguration... configs)	Add the SessionConfiguration instances to the Coherence instance that will be used to create the corresponding Session instances on start-up.
CoherenceConfiguration.Builder	withSessions(Iterable<? extends SessionConfiguration> configs)	Add the SessionConfiguration instances to the Coherence instance that will be used to create the corresponding Session instances on start-up.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

named

public CoherenceConfiguration.Builder named(String sName)

Set the name of the Coherence instance.

If the name is set ot null or empty/blank string the Coherence.DEFAULT_NAME will be used.

The name must be unique across all Coherence instances.

Parameters:

sName - the name of the Coherence instance

Returns:

this CoherenceConfiguration.Builder

withDefaultSession

public CoherenceConfiguration.Builder withDefaultSession(String sName)

Set the name of the Session to return is a Session is requested with the default name.

Parameters:

sName - the name of the default Session

Returns:

this CoherenceConfiguration.Builder

Throws:

IllegalArgumentException - if this configuration does not contain a session with the specified name

discoverSessions

public CoherenceConfiguration.Builder discoverSessions()

Add all of the SessionConfiguration instances discovered using the ServiceLoader.

Returns:

this CoherenceConfiguration.Builder

withSession

public CoherenceConfiguration.Builder withSession(SessionConfiguration config)

Add a SessionConfiguration to the Coherence instance that will be used to create the corresponding Session on start-up.

The name of the SessionConfiguration returned by the SessionConfiguration.getName() method must be unique across all Coherence instances.

Adding a SessionConfiguration with the same name as a SessionConfiguration already added to this builder will overwrite the previously added configuration.

Parameters:

config - the SessionConfiguration to configure a Session

Returns:

this CoherenceConfiguration.Builder

withSessions

public CoherenceConfiguration.Builder withSessions(Iterable<? extends SessionConfiguration> configs)

Add the SessionConfiguration instances to the Coherence instance that will be used to create the corresponding Session instances on start-up.

The name of the SessionConfiguration returned by the SessionConfiguration.getName() method must be unique across all Coherence instances.

Adding a SessionConfiguration with the same name as a SessionConfiguration already added to this builder will overwrite the previously added configuration.

Parameters:

configs - the SessionConfiguration instances to configure Session instances

Returns:

this CoherenceConfiguration.Builder

withSessions

public CoherenceConfiguration.Builder withSessions(SessionConfiguration... configs)

Add the SessionConfiguration instances to the Coherence instance that will be used to create the corresponding Session instances on start-up.

The name of the SessionConfiguration returned by the SessionConfiguration.getName() method must be unique across all Coherence instances.

Adding a SessionConfiguration with the same name as a SessionConfiguration already added to this builder will overwrite the previously added configuration.

Parameters:

configs - the SessionConfiguration instances to configure Session instances

Returns:

this CoherenceConfiguration.Builder

withEventInterceptor

public CoherenceConfiguration.Builder withEventInterceptor(EventInterceptor<?> interceptor)

Add an EventInterceptor that will be added to all Session instances as they are created on start-up.

Parameters:

interceptor - the EventInterceptor to add

Returns:

this CoherenceConfiguration.Builder

withEventInterceptors

public CoherenceConfiguration.Builder withEventInterceptors(EventInterceptor<?>... interceptors)

Add the EventInterceptor instances that will be added to all Session instances as they are created on start-up.

Parameters:

interceptors - the EventInterceptor instances to add

Returns:

this CoherenceConfiguration.Builder

withEventInterceptors

public CoherenceConfiguration.Builder withEventInterceptors(Iterable<? extends EventInterceptor<?>> interceptors)

Add the EventInterceptor instances that will be added to all Session instances as they are created on start-up.

Parameters:

interceptors - the EventInterceptor instances to add

Returns:

this CoherenceConfiguration.Builder

withApplicationContext

public CoherenceConfiguration.Builder withApplicationContext(com.tangosol.application.Context context)

Set the application context to associate to the Coherence instance.

Parameters:

context - the application context to associate to the Coherence instance

Returns:

this CoherenceConfiguration.Builder

build

public CoherenceConfiguration build()

Build a CoherenceConfiguration from this CoherenceConfiguration.Builder.

Returns:

a CoherenceConfiguration created from this CoherenceConfiguration.Builder