org.apache.axis2.clustering.management

Interface GroupManagementAgent

public interface GroupManagementAgent

This is the interface through which the load balancing event are notified. This will only be used when this member is running in loadBalance mode. In order to do this, in the axis2.xml file, set the value of the "mode" parameter to "loadBalance" and then provide the class that implements this interface using the "loadBalanceEventHandler" entry.

Method Summary

Modifier and Type	Method and Description
void	addMember(Member member) Add a well-known member
void	applicationMemberAdded(Member member) An application member joined the application group
void	applicationMemberRemoved(Member member) An application member left the application group
java.lang.String	getDescription() Get the description about this group management agent
java.util.List<Member>	getMembers() Get the list of current members
void	send(GroupManagementCommand command) Send a GroupManagementCommand to the group
void	setDescription(java.lang.String description) Set the description about this group management agent
void	setDomain(java.lang.String domain) Set the cluster domain
void	setGroupMgtPort(int groupMgtPort) The port used for the group management member
void	setSubDomain(java.lang.String subDomain) Set the cluster sub-domain

Method Detail

setDomain

void setDomain(java.lang.String domain)

Set the cluster domain

Parameters:

domain - the cluster domain

setSubDomain

void setSubDomain(java.lang.String subDomain)

Set the cluster sub-domain

Parameters:

subDomain - the cluster sub-domain

setGroupMgtPort

void setGroupMgtPort(int groupMgtPort)

The port used for the group management member

Parameters:

groupMgtPort - The clustering port for the group, if applicable

setDescription

void setDescription(java.lang.String description)

Set the description about this group management agent

Parameters:

description - The description

getDescription

java.lang.String getDescription()

Get the description about this group management agent

Returns:

The description

applicationMemberAdded

void applicationMemberAdded(Member member)

An application member joined the application group

Parameters:

member - Represents the member who joined

applicationMemberRemoved

void applicationMemberRemoved(Member member)

An application member left the application group

Parameters:

member - Represents the member who left

getMembers

java.util.List<Member> getMembers()

Get the list of current members

Returns:

List of current members

addMember

void addMember(Member member)

Add a well-known member

Parameters:

member - The well-known member

send

void send(GroupManagementCommand command)
   throws ClusteringFault

Send a GroupManagementCommand to the group

Parameters:

command - The command

Throws:

ClusteringFault - If an error occurs while sending the command