Package weblogic.coherence.descriptor.wl

Interface CoherenceClusterParamsBean

All Superinterfaces:

SettableBean

public interface CoherenceClusterParamsBean
extends SettableBean

Access limited to the following security roles:

Deployer

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	IMB
static java.lang.String	MULTICAST
static java.lang.String	SDMB
static java.lang.String	SSL
static java.lang.String	SSLUDP
static java.lang.String	TCP
static java.lang.String	TMB
static java.lang.String	UDP
static java.lang.String	UNICAST

Method Summary

Modifier and Type	Method	Description
CoherenceCacheBean	createCoherenceCache(java.lang.String name)	Creates a new CoherenceCache bean representing the specified cache and adds it to the list of currently existing beans.
CoherenceServiceBean	createCoherenceService(java.lang.String name)	Creates a new CoherenceService bean representing the specified Service and adds it to the list of currently existing beans.
void	destroyCoherenceCache(CoherenceCacheBean bean)	Destroys the bean representing the Coherence cache and removes it from the list of currently existing beans.
void	destroyCoherenceService(CoherenceServiceBean bean)	Destroys the bean representing the Coherence Service and removes it from the list of currently existing beans.
java.lang.String	getClusteringMode()	Specifies a clustering mode of either Unicast (default) or Multicast.
int	getClusterListenPort()	The cluster listen port used by Coherence; Coherence cluster members use this port to discover and join, or create the cluster.
CoherenceCacheBean[]	getCoherenceCaches()	An array of CoherenceCache beans, each of which represents a Coherence cache.
CoherenceClusterWellKnownAddressesBean	getCoherenceClusterWellKnownAddresses()	The CoherenceClusterWellKnownAddressMBeans that have been defined for this CoherenceClusterBean.
CoherenceIdentityAsserterBean	getCoherenceIdentityAsserter()	Gets the Coherence IdentityAsserter.
CoherenceKeystoreParamsBean	getCoherenceKeystoreParams()	Gets the Keystore params for the Coherence Identity.
CoherenceServiceBean[]	getCoherenceServices()	An array of CoherenceService beans, each of which represents a Coherence Service.
java.lang.String	getGlobalSocketProvider()	Specify the Global Socket Provider name.
java.lang.String	getMulticastListenAddress()	The IP address for the cluster multicast listener.
int	getMulticastListenPort()	Deprecated. 12.2.1.0.0 Use getClusterListenPort.
int	getTimeToLive()	Sets the time-to-live (TTL) setting for the multicast message.
java.lang.String	getTransport()	Specify the underlying transport protocol to use for cluster communication.
int	getUnicastListenPort()	Deprecated. 12.2.1.0.0 Use getClusterListenPort
boolean	isIgnoreHostnameVerification()	Check if ignore hostname verification is set.
boolean	isSecuredProduction()	Specify whether secured production mode is enabled.
boolean	isSecurityFrameworkEnabled()	Check if security framework is enabled
boolean	isUnicastPortAutoAdjust()	Deprecated. 12.2.1.0.0
boolean	isUseVirtualThreads()	Check if use virtual threads is set.
CoherenceCacheBean	lookupCoherenceCache(java.lang.String name)	The bean representing the specified Coherence cache.
CoherenceServiceBean	lookupCoherenceService(java.lang.String name)	The bean representing the specified Coherence Service.
void	setClusteringMode(java.lang.String mode)	Sets the clustering mode.
void	setClusterListenPort(int port)	Sets the cluster listen port for Coherence.
void	setGlobalSocketProvider(java.lang.String globalSocketProvider)	Set the global socket provider.
void	setIgnoreHostnameVerification(boolean ignoreHostnameVerification)	Ignore hostname verification if set to true.
void	setMulticastListenAddress(java.lang.String ipAddress)	Sets the IP address for the cluster multicast listener.
void	setMulticastListenPort(int port)	Deprecated. 12.2.1.0.0 Use getClusterListenPort.
void	setSecuredProduction(boolean securedProduction)	Enable secured production mode if set to true.
void	setSecurityFrameworkEnabled(boolean securityFrameworkEnabled)	Enables Security Framework
void	setTimeToLive(int ttl)	The time-to-live setting for the multicast message.
void	setTransport(java.lang.String transport)	Sets the transport type.
void	setUnicastListenPort(int port)	Deprecated. 12.2.1.0.0 Use setClusterListenPort
void	setUnicastPortAutoAdjust(boolean adjust)	Deprecated. 12.2.1.0.0
void	setUseVirtualThreads(boolean useVirtualThreads)	Use virtual threads if set to true.

Field Detail

MULTICAST

static final java.lang.String MULTICAST

See Also:

Constant Field Values

UNICAST

static final java.lang.String UNICAST

See Also:

Constant Field Values

UDP

static final java.lang.String UDP

See Also:

Constant Field Values

TCP

static final java.lang.String TCP

See Also:

Constant Field Values

SSL

static final java.lang.String SSL

See Also:

Constant Field Values

SSLUDP

static final java.lang.String SSLUDP

See Also:

Constant Field Values

TMB

static final java.lang.String TMB

See Also:

Constant Field Values

SDMB

static final java.lang.String SDMB

See Also:

Constant Field Values

IMB

static final java.lang.String IMB

See Also:

Constant Field Values

Method Detail

getClusterListenPort

int getClusterListenPort()

The cluster listen port used by Coherence; Coherence cluster members use this port to discover and join, or create the cluster. If unspecified, the Coherence cluster multicast listen port will be used.

See Also:

weblogic.management.configuration.CoherenceMemberConfigMBean#getClusterListenPort

setClusterListenPort

void setClusterListenPort(int port)

Sets the cluster listen port for Coherence.

Default Value:

0

Maximum Value:

65535

Minimum Value:

0

getUnicastListenPort

@Deprecated
int getUnicastListenPort()

Deprecated.

12.2.1.0.0 Use getClusterListenPort

The port for the cluster unicast listener.

See Also:

CoherenceMemberConfigMBean.getUnicastListenPort()

setUnicastListenPort

@Deprecated
void setUnicastListenPort(int port)

Deprecated.

12.2.1.0.0 Use setClusterListenPort

Sets the port for the cluster unicast listener. This method is deprecated.

Parameters:

port -

See Also:

CoherenceMemberConfigMBean.setUnicastListenPort(int)

Default Value:

0

Maximum Value:

65535

Minimum Value:

0

isUnicastPortAutoAdjust

@Deprecated
boolean isUnicastPortAutoAdjust()

Deprecated.

12.2.1.0.0

Specifies whether the unicast port will be automatically incremented if the port cannot be bound because it is already in use.

See Also:

CoherenceMemberConfigMBean.getUnicastPortAutoAdjustAttempts()

setUnicastPortAutoAdjust

@Deprecated
void setUnicastPortAutoAdjust(boolean adjust)

Deprecated.

12.2.1.0.0

Sets the unicast port to be automatically incremented if the specified port cannot be bound because it is already in use.

Parameters:

adjust -

See Also:

CoherenceMemberConfigMBean.setUnicastPortAutoAdjustAttempts(int)

Default Value:

true

getMulticastListenAddress

java.lang.String getMulticastListenAddress()

The IP address for the cluster multicast listener.

setMulticastListenAddress

void setMulticastListenAddress(java.lang.String ipAddress)

Sets the IP address for the cluster multicast listener.

Parameters:

ipAddress -

getMulticastListenPort

@Deprecated
int getMulticastListenPort()

Deprecated.

12.2.1.0.0 Use getClusterListenPort.

The port for the cluster multicast listener.

setMulticastListenPort

@Deprecated
void setMulticastListenPort(int port)

Deprecated.

12.2.1.0.0 Use getClusterListenPort.

Sets the port for the cluster multicast listener.

Parameters:

port -

Default Value:

33387

Maximum Value:

65535

Minimum Value:

1

getTimeToLive

int getTimeToLive()

Sets the time-to-live (TTL) setting for the multicast message. The TTL setting designates how far multicast UDP/IP packets can travel on a network. The TTL is expressed in terms of how many hops a packet survives; each network interface, router, and managed switch is considered one hop. The TTL value should be set to the lowest integer value that works. Setting the value too high can use unnecessary bandwidth on other LAN segments and can even cause the operating system or network devices to disable multicast traffic.

Typically, setting the TTL value to 1 works on a simple switched backbone. A value of 2 or more may be required on an advanced backbone with intelligent switching. A value of 0 is used for single server clusters that are used for development and testing.

setTimeToLive

void setTimeToLive(int ttl)

The time-to-live setting for the multicast message.

Parameters:

ttl -

Default Value:

4

Maximum Value:

255

Minimum Value:

0

getCoherenceClusterWellKnownAddresses

CoherenceClusterWellKnownAddressesBean getCoherenceClusterWellKnownAddresses()

The CoherenceClusterWellKnownAddressMBeans that have been defined for this CoherenceClusterBean.

Returns:

CoherenceClusterWellKnownAddressesBean object

getClusteringMode

java.lang.String getClusteringMode()

Specifies a clustering mode of either Unicast (default) or Multicast. If multicast is undesirable or unavailable in an environment, or when an environment is not properly configured to support multicast, then setting up the Well Known Addresses (WKA) feature is required. All cluster multicast communication is disabled if any of WKA, SSL, and/or secured production mode is/are enabled.

setClusteringMode

void setClusteringMode(java.lang.String mode)

Sets the clustering mode.

Parameters:

mode -

Default Value:

CoherenceClusterParamsBean.UNICAST

Valid Values:

CoherenceClusterParamsBean.MULTICAST, CoherenceClusterParamsBean.UNICAST

getTransport

java.lang.String getTransport()

Specify the underlying transport protocol to use for cluster communication. Default is SSL when secured production mode is enabled; TMB otherwise.

The transport type can be one of the following:

• TMB: UDP + TMB
• TCP: TCP + TMB
• UDP: UDP + datagram
• SSL: SSL over TCP + TMBS
• SSLUDP: SSL over TCP + SSL over datagram
• SDMB: UDP + SDMB
• IMB: UDP + IMB

Where: "TMB: UDP + TMB" means for transport type TMB, cluster service communication uses UDP; reliable point-to-point data service communication uses TMB. The default is TMB.

The SDMB and IMB are only applicable to Exalogic environment.

Valid Values:

CoherenceClusterParamsBean.TMB, CoherenceClusterParamsBean.TCP, CoherenceClusterParamsBean.UDP, CoherenceClusterParamsBean.SSL, CoherenceClusterParamsBean.SSLUDP, CoherenceClusterParamsBean.SDMB, CoherenceClusterParamsBean.IMB

setTransport

void setTransport(java.lang.String transport)

Sets the transport type.

Parameters:

transport -

isSecurityFrameworkEnabled

boolean isSecurityFrameworkEnabled()

Check if security framework is enabled

setSecurityFrameworkEnabled

void setSecurityFrameworkEnabled(boolean securityFrameworkEnabled)

Enables Security Framework

Parameters:

securityFrameworkEnabled -

getGlobalSocketProvider

java.lang.String getGlobalSocketProvider()

Specify the Global Socket Provider name. If not specified and secured production mode is enabled, Coherence uses WebLogic SSL configuration as Global Socket Provider. Otherwise, use the specified Global Socket Provider.

setGlobalSocketProvider

void setGlobalSocketProvider(java.lang.String globalSocketProvider)

Set the global socket provider.

Parameters:

globalSocketProvider -

getCoherenceIdentityAsserter

CoherenceIdentityAsserterBean getCoherenceIdentityAsserter()

Gets the Coherence IdentityAsserter.

Returns:

CoherenceIdentityAsserterBean object

getCoherenceKeystoreParams

CoherenceKeystoreParamsBean getCoherenceKeystoreParams()

Gets the Keystore params for the Coherence Identity.

Returns:

CoherenceKeystoreParamsBean object

getCoherenceCaches

CoherenceCacheBean[] getCoherenceCaches()

An array of CoherenceCache beans, each of which represents a Coherence cache.

Returns:

an array of CoherenceCacheBean objects

createCoherenceCache

CoherenceCacheBean createCoherenceCache(java.lang.String name)

Creates a new CoherenceCache bean representing the specified cache and adds it to the list of currently existing beans.

Parameters:

name -

lookupCoherenceCache

CoherenceCacheBean lookupCoherenceCache(java.lang.String name)

The bean representing the specified Coherence cache.

Parameters:

name -

destroyCoherenceCache

void destroyCoherenceCache(CoherenceCacheBean bean)

Destroys the bean representing the Coherence cache and removes it from the list of currently existing beans.

Parameters:

bean -

getCoherenceServices

CoherenceServiceBean[] getCoherenceServices()

An array of CoherenceService beans, each of which represents a Coherence Service.

Returns:

an array of CoherenceServiceBean objects

createCoherenceService

CoherenceServiceBean createCoherenceService(java.lang.String name)

Creates a new CoherenceService bean representing the specified Service and adds it to the list of currently existing beans.

Parameters:

name -

lookupCoherenceService

CoherenceServiceBean lookupCoherenceService(java.lang.String name)

The bean representing the specified Coherence Service.

Parameters:

name -

destroyCoherenceService

void destroyCoherenceService(CoherenceServiceBean bean)

Destroys the bean representing the Coherence Service and removes it from the list of currently existing beans.

Parameters:

bean -

isSecuredProduction

boolean isSecuredProduction()

Specify whether secured production mode is enabled. When it is not set, Coherence inherits the Secured Production Mode from WebLogic. Once Coherence Secured Production Mode is specified (Yes or No), then Coherence will no longer inherit the mode from WebLogic

Default it to the corresponding WebLogic value:

Default Value:

false

setSecuredProduction

void setSecuredProduction(boolean securedProduction)

Enable secured production mode if set to true.

Parameters:

securedProduction -

isIgnoreHostnameVerification

boolean isIgnoreHostnameVerification()

Check if ignore hostname verification is set. In Secured Production Mode, Coherence hostname verification is enabled by default. If WebLogic isHostnameVerificationIgnored is set, then Coherence will inherite it through this property.

setIgnoreHostnameVerification

void setIgnoreHostnameVerification(boolean ignoreHostnameVerification)

Ignore hostname verification if set to true.

Parameters:

ignoreHostnameVerification -

Default Value:

false

isUseVirtualThreads

boolean isUseVirtualThreads()

Check if use virtual threads is set. If WebLogic the KernelMBean.virtualThreadEnableOption or the weblogic.kernel.useVirtualThreads system property is set, Coherence inherites it through this property.

setUseVirtualThreads

void setUseVirtualThreads(boolean useVirtualThreads)

Use virtual threads if set to true.

Parameters:

useVirtualThreads -