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

Part Number E27170-01

weblogic.coherence.descriptor.wl
Interface CoherenceClusterParamsBean

All Superinterfaces:
SettableBean

public interface CoherenceClusterParamsBean
extends SettableBean

Access limited to the following security roles:
Deployer

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
 CoherenceCacheBean createCoherenceCache(String name)
          Creates a new CoherenceCache bean representing the specified cache and adds it to the list of currently existing beans.
 CoherenceServiceBean createCoherenceService(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.
 String getClusteringMode()
          Specifies a clustering mode of either Unicast or Multicast.
 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.
 String getMulticastListenAddress()
          The IP address for the cluster multicast listener.
 int getMulticastListenPort()
          The port for the cluster multicast listener.
 int getTimeToLive()
          Sets the time-to-live (TTL) setting for the multicast message.
 String getTransport()
          Specify the underlying transport protocol to use for cluster communication.
 String getUnicastListenAddress()
          Deprecated. Use CoherenceMemberConfigMBean
 int getUnicastListenPort()
          The port for the cluster unicast listener.
 boolean isSecurityFrameworkEnabled()
          Check if security framework is enabled
 boolean isUnicastPortAutoAdjust()
           Specifies whether the unicast port will be automatically incremented if the port cannot be bound because it is already in use.
 CoherenceCacheBean lookupCoherenceCache(String name)
          The bean representing the specified Coherence cache.
 CoherenceServiceBean lookupCoherenceService(String name)
          The bean representing the specified Coherence Service.
 void setClusteringMode(String mode)
          Sets the clustering mode.
 void setMulticastListenAddress(String ipAddress)
          Sets the IP address for the cluster multicast listener.
 void setMulticastListenPort(int port)
          Sets the port for the cluster multicast listener.
 void setSecurityFrameworkEnabled(boolean securityFrameworkEnabled)
          Enables Security Framework
 void setTimeToLive(int ttl)
          The time-to-live setting for the multicast message.
 void setTransport(String transport)
          Sets the transport type.
 void setUnicastListenAddress(String ipAddress)
          Deprecated. Use CoherenceMemberConfigMBean
 void setUnicastListenPort(int port)
          Sets the port for the cluster unicast listener.
 void setUnicastPortAutoAdjust(boolean adjust)
           Sets the unicast port to be automatically incremented if the specified port cannot be bound because it is already in use.
 
Methods inherited from interface weblogic.descriptor.SettableBean
isSet, unSet
 

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

getUnicastListenAddress

String getUnicastListenAddress()
Deprecated. Use CoherenceMemberConfigMBean

The IP address for the cluster unicast listener.


setUnicastListenAddress

void setUnicastListenAddress(String ipAddress)
Deprecated. Use CoherenceMemberConfigMBean

Sets the IP address for the cluster unicast listener.


getUnicastListenPort

int getUnicastListenPort()

The port for the cluster unicast listener. A value of 0 indicates that the unicast listener port value will be derived from the server listen port. This value or the derived value will be used only if the CoherenceMemberConfigMBean unicast listen port is 0.

See Also:
CoherenceMemberConfigMBean.getUnicastListenPort()

setUnicastListenPort

void setUnicastListenPort(int port)

Sets the port for the cluster unicast listener.

Default Value:
0
Maximum Value:
65535
Minimum Value:
0

isUnicastPortAutoAdjust

boolean isUnicastPortAutoAdjust()

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


setUnicastPortAutoAdjust

void setUnicastPortAutoAdjust(boolean adjust)

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

Default Value:
true

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.


getMulticastListenPort

int getMulticastListenPort()

The port for the cluster multicast listener.


setMulticastListenPort

void setMulticastListenPort(int port)

Sets the port for the cluster multicast listener.

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.

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

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.

Default Value:
CoherenceClusterParamsBean.UNICAST
Valid Values:
CoherenceClusterParamsBean.MULTICAST, CoherenceClusterParamsBean.UNICAST

getTransport

String getTransport()

Specify the underlying transport protocol to use for cluster communication.


setTransport

void setTransport(String transport)

Sets the transport type.

Default Value:
CoherenceClusterParamsBean.UDP
Valid Values:
CoherenceClusterParamsBean.UDP, CoherenceClusterParamsBean.TCP, CoherenceClusterParamsBean.SSL, CoherenceClusterParamsBean.TMB, CoherenceClusterParamsBean.SDMB, CoherenceClusterParamsBean.IMB

isSecurityFrameworkEnabled

boolean isSecurityFrameworkEnabled()

Check if security framework is enabled


setSecurityFrameworkEnabled

void setSecurityFrameworkEnabled(boolean securityFrameworkEnabled)

Enables Security Framework


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.


lookupCoherenceCache

CoherenceCacheBean lookupCoherenceCache(String name)

The bean representing the specified Coherence cache.


destroyCoherenceCache

void destroyCoherenceCache(CoherenceCacheBean bean)

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


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.


lookupCoherenceService

CoherenceServiceBean lookupCoherenceService(String name)

The bean representing the specified Coherence Service.


destroyCoherenceService

void destroyCoherenceService(CoherenceServiceBean bean)

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


Copyright 1996, 2013, 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.1.2)

Part Number E27170-01