8 Managing Clusters

This chapter describes how to manage your cluster using Coherence:

• Understanding Clustering

• Joining Domains Using Well-Known Addresses

• Joining Domains Using IP-Multicast Addresses

• Coherence Configuration MBeans

• CoherenceConfigTypeMBean

• MulticastAddressMBean

• SocketAddressTypeMBean

• UnicastAddressesMBean

• UnicastAddressMBean

Understanding Clustering

Processing Servers and Signaling Servers distribute events between each other across the domain boundaries. To make the domains aware of each other, you need to join them in a cluster.

There are two ways to join the domains:

• Using well-known addresses, where the servers in one domain are aware of the IP-addresses, or host-names, of all servers in all other domains.

• Using IP-multicast. This is the default setting when creating the domain using scripts.

These two methods are mutually exclusive. You need to use one or the other on all nodes. Which method to use depends on your network topology, the number of servers, and other considerations. See section Network in Oracle Coherence Developer's Guide Release 3.5.

Oracle Coherence is used for clustering. Some of the Configuration MBeans are derived from the Coherence XML configuration. For details about the XML elements, see Operational Configuration elements in Oracle Coherence Developer's Guide Release 3.5.

Joining Domains Using Well-Known Addresses

To join domains using well-known addresses, perform the following steps in all domains:

1. Set the attribute UseWellKnownAddresses on the MBean CoherenceConfigTypeMBean.

   Set it to true.

2. Invoke the operation addUnicastAddress on the MBean UnicastAddressesMBean.

   A new Mbean that represents the address of a remote server is added to the MBean structure under UniCastAddressesMBean.

3. Set the attribute serverName on the MBean UnicastAddressMBean.

   Set it to the name of the server you are defining the IP-unicast address for. The name must correlate to the name of the server as given in the domain configuration.

   Note:

   The name must be unique across all domains.

4. Set the attribute address on the MBean SocketAddressTypeMBean.

   Set it to the host-name or IP-address the server uses for clustering.

   It corresponds to the Coherence XML configuration element <address> with the parent-element hierarchy <well-known-addresses> and <socket-address>.

5. Set the attribute Port on the MBean SocketAddressTypeMBean.

   Set it to the port the server uses for clustering.

   It corresponds to the Coherence XML configuration element <port> with the parent-element hierarchy <well-known-addresses> and <socket-address>.

Example:

You have the servers pn_1 and pn_2 defined in the Processing Domain and the servers ssu_1 and ssu_2 defined in the Signaling Domain.

You define the following both in the Processing Domain and in the Signaling Domain:

• A UnicastAddressMBean with the attribute serverName set to ssu_1.

  In the sibling SocketAddressTypeMBean you set the attribute address to the IP-address the server ssu_1 will use for clustering and the attribute Port to the port the server ssu_1 will use for clustering.

• A UnicastAddressMBean with the attribute serverName set to ssu_2.

  In the sibling SocketAddressTypeMBean you set the attribute address to the IP-address the server ssu_2 will use for clustering the attribute Port to the port the server ssu_2 will use for clustering.

• A UnicastAddressMBean with the attribute serverName set to pn_1.

  In the sibling SocketAddressTypeMBean you set the attribute address to the IP-address the server pn_1 will use for clustering and the attribute Port to the port the server pn_1 will use for clustering.

• A UnicastAddressMBean with the attribute serverName set to pn_2.

  In the sibling SocketAddressTypeMBean you set the attribute address to the IP-address the server pn_2 will use for clustering and the attribute Port to the port the server pn_2 will use for clustering.

Joining Domains Using IP-Multicast Addresses

To join a Processing Domain and a Signaling Domain using IP-multicast addresses, perform the following steps in all domains:

1. Set the attribute UseWellKnownAddresses on the MBean CoherenceConfigTypeMBean.

   Set it to false.

2. Set the attribute address on the MBean SocketAddressTypeMBean.

   Set it to the multicast IP address that a socket listens on or publishes to.

   It corresponds to the Coherence XML configuration element <address> with the parent-element hierarchy <multicast-listener>.

3. Set the attribute port on the MBean SocketAddressTypeMBean.

   Set it to the port that the socket listens or publishes on.

   It corresponds to the Coherence XML configuration element <port> with the parent-element hierarchy <multicast-listener>.

4. Set the attribute Ttl on the MBean SocketAddressTypeMBean.

   Specifies the time-to-live setting for the multicast.

   It corresponds to the Coherence XML configuration element <ttl> with the parent-element hierarchy <multicast-listener>.

Coherence Configuration MBeans

There are a set of MBeans that expose attributes and operations for configuring Coherence through JMX, shown in Figure 8–1.

Figure 8-1 Coherence Configuration MBean Hierarchy

The following sections provide reference information for the Coherence configuration MBeans.

---

CoherenceConfigTypeMBean

JAR File

oracle.axia.storage.provider.coherence-version.jar

where version is the version number of the JAR file: for example, 1.0.0.0.

Package

oracle.axia.config.beans.storage.coherence

Object Name

oracle:type=oracle.axia.cm.ConfigurationMBean,name=oracle.axia.storage.provider.coherence,version=1.0.0.0,name0=coherenceConfiguration

Number of Allowed Occurrences

Maximum: 1

Factory Method

oracle.axia.config.beans.storage.coherence.ObjectFactory

Attributes

boolean UseWellKnownAddress

Set to:

• true to use well-known addresses.

• false to use IP-multicast.

See "Understanding Clustering".

Operations

void addMulticastAddress()

Creates a MulticastAddressMBean.

MulticastAddressMBean getMulticastAddressMBean()

Gets a MulticastAddressMBean.

UnicastAddressesMBean getUnicastAddressesMBean()

Gets a UnicastAddressesMBean.

void setMulticastAddressMBean(MulticastAddressMBean val)

Sets a MulticastAddressMBean.

Parameter:

• val Object of type MulticastAddressMBean.

void setUnicastAddressesMBean(UnicastAddressesMBean val)

Sets a UnicastAddressesMBean.

Parameter:

• val Object of type UnicastAddressesMBean.

void removeMulticastAddress()

Removes a MulticastAddressMBean.

---

MulticastAddressMBean

JAR File

oracle.axia.storage.provider.coherence-version.jar

where version is the version number of the JAR file: for example, 1.0.0.0.

Package

oracle.axia.config.beans.storage.coherence

Object Name

oracle:name=oracle.axia.storage.provider.coherence,name0=coherenceConfiguration,name1=multicastAddress,type=oracle.axia.cm.ConfigurationMBean,version=1.0.0.0

Number of Allowed Occurrences

Maximum: 1

Factory Method

oracle.axia.config.beans.storage.coherence.ObjectFactory

Attributes

int Ttl

Specifies the time-to-live setting for the multicast.

It corresponds to the Coherence XML configuration element <ttl> with the parent-element hierarchy <multicast-listener>. See Operational Configuration elements in Oracle Coherence Developer's Guide Release 3.5.

Operations

void setSocketAddressMBean(SocketAddressTypeMBean val)

Sets a SocketAddressTypeMBean.

Parameter:

• val Object of type SocketAddressTypeMBean.

SocketAddressTypeMBean getSocketAddressMBean()

Gets a SocketAddressTypeMBean.

---

SocketAddressTypeMBean

JAR File

oracle.axia.storage.provider.coherence-version.jar

where version is the version number of the JAR file: for example, 1.0.0.0.

Package

oracle.axia.config.beans.storage.coherence

Object Name

Depending on the parent MBean, the object name is:

oracle:name=oracle.axia.storage.provider.coherence,name0=coherenceConfiguration,name1=unicastAddresses,name2=unicastAddress[n],name3=socketAddress,type=oracle.axia.cm.ConfigurationMBean,version=1.0.0.0

or:

oracle:name=oracle.axia.storage.provider.coherence,name0=coherenceConfiguration,name1=multicastAddress,name2=socketAddress,type=oracle.axia.cm.ConfigurationMBean,version=1.0.0.0

where n is an index for the MBean.

Number of Allowed Occurrences

Maximum: 1

Factory Method

oracle.axia.config.beans.storage.coherence.ObjectFactory

Attributes

String Address

Host-name or IP-address the server uses for clustering.

Depending on which the parent MBean is:

• It corresponds to the Coherence XML configuration element <address> with the parent-element hierarchy <well-known-addresses> and <socket-address>. For details about this setting, see Operational Configuration elements in Oracle Coherence Developer's Guide Release 3.5.

• It corresponds to the Coherence XML configuration element <address> with the parent-element hierarchy <multicast-listener>.

int Port

IP-port the server the server uses for clustering.

Depending on which the parent MBean is:

• It corresponds to the Coherence XML configuration element <port> with the parent-element hierarchy <well-known-addresses> and <socket-address>.

• It corresponds to the Coherence XML configuration element <port> with the parent-element hierarchy <multicast-listener>.

For details about this setting, see Operational Configuration elements in Oracle Coherence Developer's Guide Release 3.5

Operations

None

---

UnicastAddressesMBean

JAR File

oracle.axia.storage.provider.coherence-version.jar

where version is the version number of the JAR file: for example, 1.0.0.0.

Package

oracle.axia.config.beans.storage.coherence

Object Name

oracle:name=oracle.axia.storage.provider.coherence,name0=coherenceConfiguration,name1=unicastAddresses,type=oracle.axia.cm.ConfigurationMBean,version=1.0.0.0

Number of Allowed Occurrences

Maximum: 1

Factory Method

oracle.axia.config.beans.storage.coherence.ObjectFactory

Attributes

None

Operations

void addUnicastAddressMBean()

Creates a UnicastAddressMBean MBean. An index is generated for the MBean.

List<UnicastAddressMBean> getUnicastAddressMBean()

Lists the sibling MBeans of type UnicastAddressMBean.

void removeUnicastAddress(int index)

Removes the MBean UnicastAddressMBean.

Parameter:

• index Index of the MBean.

---

UnicastAddressMBean

JAR File

oracle.axia.storage.provider.coherence-version.jar

where version is the version number of the JAR file: for example, 1.0.0.0.

Package

oracle.axia.config.beans.storage.coherence

Object Name

oracle:name=oracle.axia.storage.provider.coherence,name0=coherenceConfiguration,name1=unicastAddresses,name2=unicastAddress[n],type=oracle.axia.cm.ConfigurationMBean,version=1.0.0.0

where n is an index for the MBean.

Number of Allowed Occurrences

Minimum: 0; No maximum

Factory Method

oracle.axia.config.beans.storage.coherence.ObjectFactory

Attributes

String ServerName

The name of the server you are defining the IP-unicast address for. The name must correlate to the name of the server as given in the domain configuration.

Operations

SocketAddressTypeMBean getSocketAddressMBean()

Gets a SocketAddressTypeMBean.

void setSocketAddressMBean(SocketAddressTypeMBean val)

Creates a SocketAddressTypeMBean.

Parameter:

• val Object of type SocketAddressTypeMBean.