tigase.cluster
Class ClusterElement

java.lang.Object
  tigase.cluster.ClusterElement

public class ClusterElement
extends java.lang.Object

Class ClusterElement is a utility class for handling tigase cluster specific packets. The cluster packet has the following form:

 
   
     
       Hello world!
     
   
   
     node1 JID address
     
       node1 JID address
       node2 JID address
     
     
       value
       value
       
         value
         value
       
     
   
 
 

If none of nodes could process the packet it goes back to the first node as this node is the most likely to process the packet correctly. Created: Fri May 2 09:40:40 2008

Version:

$Rev: 1339 $

Author:

Artur Hefczyc

Field Summary

static java.lang.String	CLUSTER_CONTROL_EL_NAME
static java.lang.String	CLUSTER_CONTROL_PATH
static java.lang.String	CLUSTER_DATA_EL_NAME
static java.lang.String	CLUSTER_DATA_PATH
static java.lang.String	CLUSTER_EL_NAME
static java.lang.String	CLUSTER_METHOD_EL_NAME
static java.lang.String	CLUSTER_METHOD_PAR_EL_NAME
static java.lang.String	CLUSTER_METHOD_PATH
static java.lang.String	CLUSTER_METHOD_RESULTS_EL_NAME
static java.lang.String	CLUSTER_METHOD_RESULTS_PATH
static java.lang.String	CLUSTER_METHOD_RESULTS_VAL_EL_NAME
static java.lang.String	CLUSTER_NAME_ATTR
static java.lang.String	FIRST_NODE_EL_NAME
static java.lang.String	FIRST_NODE_PATH
static java.lang.String	NODE_ID_EL_NAME
static java.lang.String	VISITED_NODES_EL_NAME
static java.lang.String	VISITED_NODES_PATH
static java.lang.String	XMLNS

Constructor Summary

ClusterElement(tigase.xml.Element elem)
Creates a new ClusterElement instance.

ClusterElement(java.lang.String from, java.lang.String to, StanzaType type, Packet packet)

Method Summary

void	addDataPacket(Packet packet)
void	addMethodResult(java.lang.String key, java.lang.String val)
void	addVisitedNode(java.lang.String node_id)
static tigase.xml.Element	clusterElement(java.lang.String from, java.lang.String to, StanzaType type)
static tigase.xml.Element	createClusterElement(java.lang.String from, java.lang.String to, StanzaType type, java.lang.String packet_from)
static ClusterElement	createClusterMethodCall(java.lang.String from, java.lang.String to, StanzaType type, java.lang.String method_name, java.util.Map<java.lang.String,java.lang.String> params)
static ClusterElement	createForNextNode(ClusterElement clel, java.util.Set<java.lang.String> cluster_nodes, java.lang.String comp_id)
ClusterElement	createMethodResponse(java.lang.String from, java.lang.String type, java.util.Map<java.lang.String,java.lang.String> results)
ClusterElement	createMethodResponse(java.lang.String from, java.lang.String to, java.lang.String type, java.util.Map<java.lang.String,java.lang.String> results)
java.util.Map<java.lang.String,java.lang.String>	getAllMethodParams()
java.util.Map<java.lang.String,java.lang.String>	getAllMethodResults()
tigase.xml.Element	getClusterElement()
java.util.List<tigase.xml.Element>	getDataPackets()
java.lang.String	getFirstNode()
java.lang.String	getMethodName()
java.lang.String	getMethodParam(java.lang.String par_name)
long	getMethodParam(java.lang.String par_name, long def)
java.lang.String	getMethodResultVal(java.lang.String val_name)
long	getMethodResultVal(java.lang.String val_name, long def)
java.util.Set<java.lang.String>	getVisitedNodes()
boolean	isVisitedNode(java.lang.String node_id)
ClusterElement	nextClusterNode(java.lang.String node_id)
protected void	parseMethodCall(tigase.xml.Element method_call)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

XMLNS

public static final java.lang.String XMLNS

See Also:

Constant Field Values

CLUSTER_EL_NAME

public static final java.lang.String CLUSTER_EL_NAME

See Also:

Constant Field Values

CLUSTER_CONTROL_EL_NAME

public static final java.lang.String CLUSTER_CONTROL_EL_NAME

See Also:

Constant Field Values

CLUSTER_CONTROL_PATH

public static final java.lang.String CLUSTER_CONTROL_PATH

See Also:

Constant Field Values

CLUSTER_DATA_EL_NAME

public static final java.lang.String CLUSTER_DATA_EL_NAME

See Also:

Constant Field Values

CLUSTER_DATA_PATH

public static final java.lang.String CLUSTER_DATA_PATH

See Also:

Constant Field Values

CLUSTER_METHOD_EL_NAME

public static final java.lang.String CLUSTER_METHOD_EL_NAME

See Also:

Constant Field Values

CLUSTER_METHOD_PATH

public static final java.lang.String CLUSTER_METHOD_PATH

See Also:

Constant Field Values

CLUSTER_NAME_ATTR

public static final java.lang.String CLUSTER_NAME_ATTR

See Also:

Constant Field Values

CLUSTER_METHOD_PAR_EL_NAME

public static final java.lang.String CLUSTER_METHOD_PAR_EL_NAME

See Also:

Constant Field Values

CLUSTER_METHOD_RESULTS_EL_NAME

public static final java.lang.String CLUSTER_METHOD_RESULTS_EL_NAME

See Also:

Constant Field Values

CLUSTER_METHOD_RESULTS_PATH

public static final java.lang.String CLUSTER_METHOD_RESULTS_PATH

See Also:

Constant Field Values

CLUSTER_METHOD_RESULTS_VAL_EL_NAME

public static final java.lang.String CLUSTER_METHOD_RESULTS_VAL_EL_NAME

See Also:

Constant Field Values

VISITED_NODES_EL_NAME

public static final java.lang.String VISITED_NODES_EL_NAME

See Also:

Constant Field Values

FIRST_NODE_EL_NAME

public static final java.lang.String FIRST_NODE_EL_NAME

See Also:

Constant Field Values

FIRST_NODE_PATH

public static final java.lang.String FIRST_NODE_PATH

See Also:

Constant Field Values

VISITED_NODES_PATH

public static final java.lang.String VISITED_NODES_PATH

See Also:

Constant Field Values

NODE_ID_EL_NAME

public static final java.lang.String NODE_ID_EL_NAME

See Also:

Constant Field Values

Constructor Detail

ClusterElement

public ClusterElement(tigase.xml.Element elem)

Creates a new ClusterElement instance.

ClusterElement

public ClusterElement(java.lang.String from,
                      java.lang.String to,
                      StanzaType type,
                      Packet packet)

Method Detail

clusterElement

public static tigase.xml.Element clusterElement(java.lang.String from,
                                                java.lang.String to,
                                                StanzaType type)

createClusterElement

public static tigase.xml.Element createClusterElement(java.lang.String from,
                                                      java.lang.String to,
                                                      StanzaType type,
                                                      java.lang.String packet_from)

createClusterMethodCall

public static ClusterElement createClusterMethodCall(java.lang.String from,
                                                     java.lang.String to,
                                                     StanzaType type,
                                                     java.lang.String method_name,
                                                     java.util.Map<java.lang.String,java.lang.String> params)

createMethodResponse

public ClusterElement createMethodResponse(java.lang.String from,
                                           java.lang.String type,
                                           java.util.Map<java.lang.String,java.lang.String> results)

createMethodResponse

public ClusterElement createMethodResponse(java.lang.String from,
                                           java.lang.String to,
                                           java.lang.String type,
                                           java.util.Map<java.lang.String,java.lang.String> results)

addMethodResult

public void addMethodResult(java.lang.String key,
                            java.lang.String val)

createForNextNode

public static ClusterElement createForNextNode(ClusterElement clel,
                                               java.util.Set<java.lang.String> cluster_nodes,
                                               java.lang.String comp_id)

parseMethodCall

protected void parseMethodCall(tigase.xml.Element method_call)

getMethodName

public java.lang.String getMethodName()

getMethodParam

public java.lang.String getMethodParam(java.lang.String par_name)

getMethodParam

public long getMethodParam(java.lang.String par_name,
                           long def)

getAllMethodParams

public java.util.Map<java.lang.String,java.lang.String> getAllMethodParams()

getMethodResultVal

public java.lang.String getMethodResultVal(java.lang.String val_name)

getMethodResultVal

public long getMethodResultVal(java.lang.String val_name,
                               long def)

getAllMethodResults

public java.util.Map<java.lang.String,java.lang.String> getAllMethodResults()

getFirstNode

public java.lang.String getFirstNode()

nextClusterNode

public ClusterElement nextClusterNode(java.lang.String node_id)

addDataPacket

public void addDataPacket(Packet packet)

getDataPackets

public java.util.List<tigase.xml.Element> getDataPackets()

getClusterElement

public tigase.xml.Element getClusterElement()

addVisitedNode

public void addVisitedNode(java.lang.String node_id)

isVisitedNode

public boolean isVisitedNode(java.lang.String node_id)

getVisitedNodes

public java.util.Set<java.lang.String> getVisitedNodes()