com.tangosol.coherence.config.builder

Class SocketProviderBuilder

java.lang.Object

com.tangosol.coherence.config.builder.SocketProviderBuilder

All Implemented Interfaces:

ParameterizedBuilder<com.oracle.coherence.common.net.SocketProvider>

public class SocketProviderBuilder
extends Object
implements ParameterizedBuilder<com.oracle.coherence.common.net.SocketProvider>

SocketProviderBuilder enables lazy instantiation of SocketProvider. Builder includes methods that allows one to specify whether to get a datagram or demultiplexed SocketProvider and what subport to use for the socket provider.

Since:

Coherence 12.2.1.1

Author:

jf 2015.11.11

Nested Class Summary

Nested classes/interfaces inherited from interface com.tangosol.coherence.config.builder.ParameterizedBuilder

ParameterizedBuilder.ReflectionSupport

Field Summary

Fields

Modifier and Type	Field and Description
static String	UNNAMED_PROVIDER_ID Default id for unnamed socket providers.

Constructor Summary

Constructors

Constructor and Description
SocketProviderBuilder(com.oracle.coherence.common.net.SocketProvider provider) Wrapper an existing SocketProvider into a Builder so it can be registered in cluster BuilderRegistry.
SocketProviderBuilder(String sId, SocketProviderFactory.Dependencies deps) Construct a SocketProviderBuilder from its definition id and its dependencies.

Method Summary

Modifier and Type	Method and Description
DatagramSocketProvider	getDatagramSocketProvider(int nSubport) Return an instance of the specified DatagramSocketProvider, creating it if necessary.
com.oracle.coherence.common.net.SocketProvider	getDemultiplexedSocketProvider(int nSubport) Return a Demultiplexed Socket provider
SocketProviderFactory.Dependencies	getDependencies() Return either an anonymous SocketProviderFactory dependencies for an inlined socket-provider or the global SocketProviderFactory dependencies initialized from cluster socket-providers definitions.
String	getId() Return the identifier for SocketProvider built by this builder.
com.oracle.coherence.common.net.SSLSettings	getSSLSettings() Return SSLSettings for SocketProviderBuilder.
com.oracle.coherence.common.net.SocketProvider	realize(com.tangosol.config.expression.ParameterResolver resolver, ClassLoader loader, ParameterList listParameters) Realizes (creates if necessary) an instance of a object of type T, using the provided ParameterResolver to resolve values any referenced Parameters.

Methods inherited from class java.lang.Object

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

Field Detail

UNNAMED_PROVIDER_ID

public static String UNNAMED_PROVIDER_ID

Default id for unnamed socket providers.

Constructor Detail

SocketProviderBuilder

public SocketProviderBuilder(String sId,
                             SocketProviderFactory.Dependencies deps)

Construct a SocketProviderBuilder from its definition id and its dependencies.

Parameters:

sId - provider definition id. UNNAMED_PROVIDER_ID indicates an inlined anonymous socket provider

deps - SocketProvider dependencies

SocketProviderBuilder

public SocketProviderBuilder(com.oracle.coherence.common.net.SocketProvider provider)

Wrapper an existing SocketProvider into a Builder so it can be registered in cluster BuilderRegistry.

Parameters:

provider - a SocketProvider

Method Detail

getDependencies

public SocketProviderFactory.Dependencies getDependencies()

Return either an anonymous SocketProviderFactory dependencies for an inlined socket-provider or the global SocketProviderFactory dependencies initialized from cluster socket-providers definitions.

Returns:

SocketProviderFactory.Dependencies for this builder

getId

public String getId()

Return the identifier for SocketProvider built by this builder.

Returns:

the identifier for SocketProvider returned by this builder.

getDemultiplexedSocketProvider

public com.oracle.coherence.common.net.SocketProvider getDemultiplexedSocketProvider(int nSubport)

Return a Demultiplexed Socket provider

Parameters:

nSubport - subport for demultiplexed socket provider.

Returns:

the provider

getDatagramSocketProvider

public DatagramSocketProvider getDatagramSocketProvider(int nSubport)

Return an instance of the specified DatagramSocketProvider, creating it if necessary.

Parameters:

nSubport - subport for a demultiplexed socket provider.

Returns:

the provider

getSSLSettings

public com.oracle.coherence.common.net.SSLSettings getSSLSettings()

Return SSLSettings for SocketProviderBuilder.

Returns:

the sslSettings if the socket provider builder has a ssl settings directly or via delegate.

realize

public com.oracle.coherence.common.net.SocketProvider realize(com.tangosol.config.expression.ParameterResolver resolver,
                                                              ClassLoader loader,
                                                              ParameterList listParameters)

Description copied from interface: ParameterizedBuilder

Realizes (creates if necessary) an instance of a object of type T, using the provided ParameterResolver to resolve values any referenced Parameters.

Specified by:

realize in interface ParameterizedBuilder<com.oracle.coherence.common.net.SocketProvider>

Parameters:

resolver - the ParameterResolver for resolving named Parameters

loader - the ClassLoader for loading any necessary classes and if null the ClassLoader used to load the builder will be used instead

listParameters - an optional ParameterList (may be null) to be used for realizing the instance, eg: used as constructor parameters

Returns:

an instance of T