10 Managing Clusters

This chapter describes how to manage clusters.

About Clustering

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

You can group the domains into clusters using one of the following way:

Using well-known addresses. In this case, servers in one domain are aware of the IP-addresses, or host-names, of all servers in all other domains (see "Grouping Domains Using Well-Known Addresses" for more information).
Using IP-multicast. This is the default setting when creating the domain using scripts (see "Grouping Domains Using IP-Multicast Addresses" for more information).

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.

You can group domains into clusters using CoherenceConfigTypeMBean. Figure 10-1 shows the CoherenceConfigTypeMBean hierarchy. CoherenceConfigTypeMBean contains UnicastAddressesMBean and MulticastAddressMBean.

Figure 10-1 Coherence Configuration MBean Hierarchy

Grouping Domains Using Well-Known Addresses

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

Set the UseWellKnownAddresses attribute of CoherenceConfigTypeMBean to true.
Invoke the following operation of UnicastAddressesMBean:
```
void addUnicastAddress()
```
A new instance of UnicastAddressMBean that represents the address of a remote server is added to the MBean structure under UniCastAddressesMBean.
Set the serverName attribute of UnicastAddressMBean to the name of the server for which you define the IP-unicast address. The name must correlate to the name of the server as specified in the domain configuration.

Note:
The name must be unique across all domains.
Set the address attribute of SocketAddressTypeMBean to the host-name or IP-address that the server uses for clustering.

The value of the address attribute corresponds to the Coherence XML configuration element address with the parent-element hierarchy well-known-addresses and socket-address.
Set the attribute Port on the MBean SocketAddressTypeMBean to the port the server uses for clustering.

The value of the Port attribute corresponds to the Coherence XML configuration element port with the parent-element hierarchy well-known-addresses and socket-address.

See "CoherenceConfigTypeMBean" for more information about these MBeans.

For example, when servers pn_1 and pn_2 are defined in the Processing Domain and the servers ssu_1 and ssu_2 are defined in the Signaling Domain, you need to define the following in both the Processing Domain and in the Signaling Domain:

A UnicastAddressMBean with the serverName attribute set to ssu_1.

In the sibling SocketAddressTypeMBean, you set the address attribute to the IP-address the server ssu_1 will use for clustering and the Port attribute to the port the server ssu_1 will use for clustering.
A UnicastAddressMBean with the serverName attribute set to ssu_2.

In the sibling SocketAddressTypeMBean, you set the address attribute 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 serverName attribute set to pn_1.

In the sibling SocketAddressTypeMBean, you set the address attribute to the IP-address the server pn_1 will use for clustering and the Port attribute to the port the server pn_1 will use for clustering.
A UnicastAddressMBean with the serverName attribute set to pn_2.

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

Grouping Domains Using IP-Multicast Addresses

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

Set the UseWellKnownAddresses attribute of CoherenceConfigTypeMBean to false.
Set the address attribute of SocketAddressTypeMBean to the multicast IP address that a socket listens on or publishes to.

The address attribute corresponds to the Coherence XML configuration element address with the parent-element hierarchy multicast-listener.
Set the port attribute of SocketAddressTypeMBean to the port that the socket listens or publishes on.

The port attribute corresponds to the Coherence XML configuration element port with the parent-element hierarchy multicast-listener.
To specify the time-to-live setting for the multicast, set the Ttl attribute of SocketAddressTypeMBean.

The Ttl attribute corresponds to the Coherence XML configuration element ttl with the parent-element hierarchy multicast-listener.

See "CoherenceConfigTypeMBean" for more information about these MBeans.

CoherenceConfigTypeMBean

JAR File

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

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 "About 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

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

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

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

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

Operations

None

UnicastAddressesMBean

JAR File

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

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

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

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.