Skip navigation links

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09


weblogic.coherence.descriptor.wl
Interface CoherenceClusterParamsBean

All Superinterfaces:
SettableBean

public interface CoherenceClusterParamsBean
extends SettableBean

Field Summary
static String IMB
           
static String MULTICAST
           
static String SDMB
           
static String SSL
           
static String TCP
           
static String TMB
           
static String UDP
           
static String UNICAST
           

 

Method Summary
abstract  CoherenceCacheBean createCoherenceCache(String name)
          Creates a new CoherenceCache bean representing the specified cache and adds it to the list of currently existing beans.
abstract  CoherenceServiceBean createCoherenceService(String name)
          Creates a new CoherenceService bean representing the specified Service and adds it to the list of currently existing beans.
abstract  void destroyCoherenceCache(CoherenceCacheBean bean)
          Destroys the bean representing the Coherence cache and removes it from the list of currently existing beans.
abstract  void destroyCoherenceService(CoherenceServiceBean bean)
          Destroys the bean representing the Coherence Service and removes it from the list of currently existing beans.
abstract  String getClusteringMode()
          Specifies a clustering mode of either Unicast or Multicast.
abstract  int getClusterListenPort()
          The cluster listen port used by Coherence; Coherence cluster members use this port to discover and join, or create the cluster.
abstract  CoherenceCacheBean[] getCoherenceCaches()
          An array of CoherenceCache beans, each of which represents a Coherence cache.
abstract  CoherenceClusterWellKnownAddressesBean getCoherenceClusterWellKnownAddresses()
          The CoherenceClusterWellKnownAddressMBeans that have been defined for this CoherenceClusterBean.
abstract  CoherenceIdentityAsserterBean getCoherenceIdentityAsserter()
          Gets the Coherence IdentityAsserter.
abstract  CoherenceKeystoreParamsBean getCoherenceKeystoreParams()
          Gets the Keystore params for the Coherence Identity.
abstract  CoherenceServiceBean[] getCoherenceServices()
          An array of CoherenceService beans, each of which represents a Coherence Service.
abstract  String getMulticastListenAddress()
          The IP address for the cluster multicast listener.
abstract  int getMulticastListenPort()
          Deprecated. Use getClusterListenPort.
abstract  int getTimeToLive()
          Sets the time-to-live (TTL) setting for the multicast message.
abstract  String getTransport()
          Specify the underlying transport protocol to use for cluster communication.
abstract  int getUnicastListenPort()
          Deprecated. Use getClusterListenPort
abstract  boolean isSecurityFrameworkEnabled()
          Check if security framework is enabled
abstract  boolean isUnicastPortAutoAdjust()
          Deprecated.  
abstract  CoherenceCacheBean lookupCoherenceCache(String name)
          The bean representing the specified Coherence cache.
abstract  CoherenceServiceBean lookupCoherenceService(String name)
          The bean representing the specified Coherence Service.
abstract  void setClusteringMode(String mode)
          Sets the clustering mode.
abstract  void setClusterListenPort(int port)
          Sets the cluster listen port for Coherence.
abstract  void setMulticastListenAddress(String ipAddress)
          Sets the IP address for the cluster multicast listener.
abstract  void setMulticastListenPort(int port)
          Deprecated. Use getClusterListenPort.
abstract  void setSecurityFrameworkEnabled(boolean securityFrameworkEnabled)
          Enables Security Framework
abstract  void setTimeToLive(int ttl)
          The time-to-live setting for the multicast message.
abstract  void setTransport(String transport)
          Sets the transport type.
abstract  void setUnicastListenPort(int port)
          Deprecated. Use setClusterListenPort
abstract  void setUnicastPortAutoAdjust(boolean adjust)
          Deprecated.  

 

Field Detail

MULTICAST

static final String MULTICAST
See Also:
Constant Field Values

UNICAST

static final String UNICAST
See Also:
Constant Field Values

UDP

static final String UDP
See Also:
Constant Field Values

TCP

static final String TCP
See Also:
Constant Field Values

SSL

static final String SSL
See Also:
Constant Field Values

TMB

static final String TMB
See Also:
Constant Field Values

SDMB

static final String SDMB
See Also:
Constant Field Values

IMB

static final 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.


getUnicastListenPort

int getUnicastListenPort()
Deprecated. Use getClusterListenPort

The port for the cluster unicast listener.

See Also:
CoherenceMemberConfigMBean.getUnicastListenPort()

setUnicastListenPort

void setUnicastListenPort(int port)
Deprecated. Use setClusterListenPort

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

Parameters:
port -
See Also:
CoherenceMemberConfigMBean.setUnicastListenPort(int)

isUnicastPortAutoAdjust

boolean isUnicastPortAutoAdjust()
Deprecated. 

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

void setUnicastPortAutoAdjust(boolean adjust)
Deprecated. 

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)

getMulticastListenAddress

String getMulticastListenAddress()

The IP address for the cluster multicast listener.


setMulticastListenAddress

void setMulticastListenAddress(String ipAddress)

Sets the IP address for the cluster multicast listener.

Parameters:
ipAddress -

getMulticastListenPort

int getMulticastListenPort()
Deprecated. Use getClusterListenPort.

The port for the cluster multicast listener.


setMulticastListenPort

void setMulticastListenPort(int port)
Deprecated. Use getClusterListenPort.

Sets the port for the cluster multicast listener.

Parameters:
port -

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 -

getCoherenceClusterWellKnownAddresses

CoherenceClusterWellKnownAddressesBean getCoherenceClusterWellKnownAddresses()

The CoherenceClusterWellKnownAddressMBeans that have been defined for this CoherenceClusterBean.

Returns:
CoherenceClusterWellKnownAddressesBean object

getClusteringMode

String getClusteringMode()

Specifies a clustering mode of either Unicast 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 WKA is enabled.


setClusteringMode

void setClusteringMode(String mode)

Sets the clustering mode.

Parameters:
mode -

getTransport

String getTransport()

Specify the underlying transport protocol to use for cluster communication. The TMB, SDMB, or IMB are only applicable to Exalogic environment.


setTransport

void setTransport(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 -

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(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(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(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(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 -

Skip navigation links

Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09