com.tangosol.net

Class SocketProviderFactory

java.lang.Object

com.tangosol.net.SocketProviderFactory

public class SocketProviderFactory
extends Object

The SocketProviderFactory produces SocketProviders.

Since:

Coherence 3.6

Author:

mf, jh, bb 2010.04.21

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SocketProviderFactory.DefaultDependencies DefaultDependencies is a basic implementation of the Dependencies interface.
static interface	SocketProviderFactory.Dependencies Dependencies specifies all dependency requirements of the SocketProviderFactory.

Field Summary

Fields

Modifier and Type	Field and Description
static DatagramSocketProvider	DEFAULT_DATAGRAM_SOCKET_PROVIDER The factory's default Datagram SocketProvider.
static com.oracle.common.net.SocketProvider	DEFAULT_LEGACY_SOCKET_PROVIDER The factory's default legacy SocketProvider.
static com.oracle.common.net.SocketProvider	DEFAULT_SOCKET_PROVIDER The factory's default SocketProvider.
protected SocketProviderFactory.Dependencies	m_Dependencies Dependencies
protected Map	m_mapDatagramSocketProvider A map of instantiated datagram socket providers, key'd by id.
protected Map	m_mapSocketProvider A map of instantiated socket providers, key'd by id.
static String	UNNAMED_PROVIDER_ID Default id for unnamed socket and datagram socket providers

Constructor Summary

Constructors

Constructor and Description
SocketProviderFactory() Construct a SocketProviderFactory
SocketProviderFactory(SocketProviderFactory.Dependencies dependencies) Construct a SocketProviderFactory.

Method Summary

Modifier and Type	Method and Description
static com.oracle.common.net.SSLSettings	createSSLSettings(com.oracle.common.net.SSLSocketProvider.Dependencies depsSSL) Return an SSLSettings initilize via SSLSocketProvider.Dependencies
protected DatagramSocketProvider	ensureDatagramSocketProvider(String sId, SocketProviderFactory.Dependencies providerDeps, int nSubport) Create DatatgramSocketProvider
protected com.oracle.common.net.SocketProvider	ensureSocketProvider(String sId, SocketProviderFactory.Dependencies deps, int nSubport) Create SocketProvider
DatagramSocketProvider	getDatagramSocketProvider(String sId, SocketProviderFactory.Dependencies deps, int nSubport) Return an instance of the specified DatagramSocketProvider, creating it if necessary.
DatagramSocketProvider	getDatagramSocketProvider(XmlElement xml, int nSubport) Deprecated.
DatagramSocketProvider	getDefaultDatagramSocketProvider(SocketProviderBuilder builder, int nSubport) Return an instance of the specified DatagramSocketProvider, creating it if necessary.
com.oracle.common.net.SocketProvider	getDemultiplexedSocketProvider(SocketProviderBuilder builder, int nSubport) Return a Demultiplexed Socket provider
com.oracle.common.net.SocketProvider	getDemultiplexedSocketProvider(String sId, SocketProviderFactory.Dependencies deps, int nSubport) Return a Demultiplexed Socket provider
com.oracle.common.net.SocketProvider	getDemultiplexedSocketProvider(XmlElement xml, int nSubport) Deprecated.
SocketProviderFactory.Dependencies	getDependencies() Get SocketProviderDependencies object
com.oracle.common.net.SocketProvider	getLegacySocketProvider(XmlElement xml) Deprecated.
com.oracle.common.net.SocketProvider	getSocketProvider(String sId) Return a Socket provider
com.oracle.common.net.SocketProvider	getSocketProvider(String sId, SocketProviderFactory.Dependencies deps, int nSubport) Return a Socket provider
com.oracle.common.net.SocketProvider	getSocketProvider(XmlElement xml) Deprecated.
com.oracle.common.net.SSLSettings	getSSLSettings(com.oracle.common.net.SocketProvider socketProvider) Return SSLSettings for the specified SocketProvider.
com.oracle.common.net.SSLSettings	getSSLSettings(SocketProviderBuilder builder) Return SSLSettings for the specified SocketProviderBuilder.
com.oracle.common.net.SSLSettings	getSSLSettings(XmlElement xml) Deprecated.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

m_mapSocketProvider

protected Map m_mapSocketProvider

A map of instantiated socket providers, key'd by id.

m_mapDatagramSocketProvider

protected Map m_mapDatagramSocketProvider

A map of instantiated datagram socket providers, key'd by id.

m_Dependencies

protected SocketProviderFactory.Dependencies m_Dependencies

Dependencies

DEFAULT_SOCKET_PROVIDER

public static final com.oracle.common.net.SocketProvider DEFAULT_SOCKET_PROVIDER

The factory's default SocketProvider.

DEFAULT_LEGACY_SOCKET_PROVIDER

public static final com.oracle.common.net.SocketProvider DEFAULT_LEGACY_SOCKET_PROVIDER

The factory's default legacy SocketProvider.

DEFAULT_DATAGRAM_SOCKET_PROVIDER

public static final DatagramSocketProvider DEFAULT_DATAGRAM_SOCKET_PROVIDER

The factory's default Datagram SocketProvider.

UNNAMED_PROVIDER_ID

public static final String UNNAMED_PROVIDER_ID

Default id for unnamed socket and datagram socket providers

See Also:

Constant Field Values

Constructor Detail

SocketProviderFactory

public SocketProviderFactory()

Construct a SocketProviderFactory

SocketProviderFactory

public SocketProviderFactory(SocketProviderFactory.Dependencies dependencies)

Construct a SocketProviderFactory.

Parameters:

dependencies - SocketProviderFactory dependencies or null

Method Detail

getDependencies

public SocketProviderFactory.Dependencies getDependencies()

Get SocketProviderDependencies object

Returns:

SocketProviderDependencies

getLegacySocketProvider

@Deprecated
public com.oracle.common.net.SocketProvider getLegacySocketProvider(XmlElement xml)

Deprecated.

Return a Socket provider. Only there for Proxy till they move to use MultiplexedSocketProvider

Parameters:

xml - provider definition, or null for the default provider

Returns:

the provider

getSocketProvider

@Deprecated
public com.oracle.common.net.SocketProvider getSocketProvider(XmlElement xml)

Deprecated.

Return a Socket provider

Parameters:

xml - provider definition, or null for the default provider

Returns:

the provider

getSocketProvider

public com.oracle.common.net.SocketProvider getSocketProvider(String sId)

Return a Socket provider

Parameters:

sId - provider name defined in <socket-providers>

Returns:

the provider

getSocketProvider

public com.oracle.common.net.SocketProvider getSocketProvider(String sId,
                                                              SocketProviderFactory.Dependencies deps,
                                                              int nSubport)

Return a Socket provider

Parameters:

sId - provider name defined in <socket-providers>

deps - anonymous SocketProviderFactory.Dependencies

nSubport - Subport for Demultiplexed socket provider. If it is 0, then it implies Multiplexed socket provider.

Returns:

the provider

getDemultiplexedSocketProvider

@Deprecated
public com.oracle.common.net.SocketProvider getDemultiplexedSocketProvider(XmlElement xml,
                                                                                        int nSubport)

Deprecated.

Return a Demultiplexed Socket provider

Parameters:

xml - provider definition, or null for the default provider

nSubport - subport for demultiplexed socket provider.

Returns:

the provider

getDemultiplexedSocketProvider

public com.oracle.common.net.SocketProvider getDemultiplexedSocketProvider(String sId,
                                                                           SocketProviderFactory.Dependencies deps,
                                                                           int nSubport)

Return a Demultiplexed Socket provider

Parameters:

sId - provider definition identifier or UNNAMED_PROVIDER_ID for inlined, anonymous socketprovider

deps - inlined socket provider dependencies, must be non-null if sId is set to

nSubport - subport for demultiplexed socket provider.

Returns:

a DemultiplexedSocketProvider based on method parameters.

getDemultiplexedSocketProvider

public com.oracle.common.net.SocketProvider getDemultiplexedSocketProvider(SocketProviderBuilder builder,
                                                                           int nSubport)

Return a Demultiplexed Socket provider

Parameters:

builder - use socket provider id and dependencies from this SocketProviderBuilder

nSubport - subport for demultiplexed socket provider.

Returns:

a DemultiplexedSocketProvider based on method parameters.

getDatagramSocketProvider

@Deprecated
public DatagramSocketProvider getDatagramSocketProvider(XmlElement xml,
                                                                     int nSubport)

Deprecated.

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

Parameters:

xml - the provider definition, or null for the default provider

nSubport - subport for a demultiplexed socket provider.

Returns:

the provider

getDatagramSocketProvider

public DatagramSocketProvider getDatagramSocketProvider(String sId,
                                                        SocketProviderFactory.Dependencies deps,
                                                        int nSubport)

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

Parameters:

sId - provider definition identifier or UNNAMED_PROVIDER_ID for inlined, anonymous socketprovider

deps - inlined socket provider dependencies, must be non-null if sId is set to

nSubport - subport for DatagramSocketProvider.

Returns:

a DatagramSocketProvider configured via method parameters

getDefaultDatagramSocketProvider

public DatagramSocketProvider getDefaultDatagramSocketProvider(SocketProviderBuilder builder,
                                                               int nSubport)

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

Parameters:

builder - use socket provider id and dependencies from this SocketProviderBuilder

nSubport - subport for DatagramSocketProvider.

Returns:

a DatagramSocketProvider configured via method parameters

getSSLSettings

@Deprecated
public com.oracle.common.net.SSLSettings getSSLSettings(XmlElement xml)

Deprecated.

Return an instance of SSLSettings from the specified xml.

Parameters:

xml - the provider definition, or null for the default provider

Returns:

the sslSettings

getSSLSettings

public com.oracle.common.net.SSLSettings getSSLSettings(com.oracle.common.net.SocketProvider socketProvider)

Return SSLSettings for the specified SocketProvider.

Parameters:

socketProvider - the socketProvider

Returns:

the sslSettings if the socket provider is an instance of SSLSocketProvider or null

getSSLSettings

public com.oracle.common.net.SSLSettings getSSLSettings(SocketProviderBuilder builder)

Return SSLSettings for the specified SocketProviderBuilder.

Parameters:

builder - the socketProviderBuilder

Returns:

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

createSSLSettings

public static com.oracle.common.net.SSLSettings createSSLSettings(com.oracle.common.net.SSLSocketProvider.Dependencies depsSSL)

Return an SSLSettings initilize via SSLSocketProvider.Dependencies

Parameters:

depsSSL - SSL Dependencies info

Returns:

a new SSLSettings initialized via depsSSL

ensureSocketProvider

protected com.oracle.common.net.SocketProvider ensureSocketProvider(String sId,
                                                                    SocketProviderFactory.Dependencies deps,
                                                                    int nSubport)

Create SocketProvider

Parameters:

sId - SocketProviderId

deps - Dependencies for the given SocketProvider

nSubport - Subport for Demultiplexed socket provider. If it is 0, then it implies Multiplexed socket provider.

Returns:

the SocketProvider

ensureDatagramSocketProvider

protected DatagramSocketProvider ensureDatagramSocketProvider(String sId,
                                                              SocketProviderFactory.Dependencies providerDeps,
                                                              int nSubport)

Create DatatgramSocketProvider

Parameters:

sId - DatagramSocketProviderId

providerDeps - Dependencies for the given DatagramSocketProvider

nSubport - Subport for Demultiplexed socket provider. If it is 0, then it implies Multiplexed socket provider.

Returns:

the DatagramSocketProvider

toString

public String toString()

Overrides:

toString in class Object