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: 2047 $

Author:

Artur Hefczyc

Field Summary

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

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

Method Summary

void	addDataPacket(tigase.xml.Element packet) Method description
void	addDataPacket(Packet packet) Method description
void	addMethodResult(java.lang.String key, java.lang.String val) Method description
void	addVisitedNode(java.lang.String node_id) Method description
static tigase.xml.Element	clusterElement(java.lang.String from, java.lang.String to, StanzaType type) Method description
static tigase.xml.Element	createClusterElement(java.lang.String from, java.lang.String to, StanzaType type, java.lang.String packet_from) Method description
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) Method description
static ClusterElement	createForNextNode(ClusterElement clel, java.util.List<tigase.xmpp.JID> cluster_nodes, tigase.xmpp.JID comp_id) Method description
ClusterElement	createMethodResponse(java.lang.String from, StanzaType type, java.util.Map<java.lang.String,java.lang.String> results) Method description
ClusterElement	createMethodResponse(java.lang.String from, java.lang.String to, StanzaType type, java.util.Map<java.lang.String,java.lang.String> results) Method description
java.util.Map<java.lang.String,java.lang.String>	getAllMethodParams() Method description
java.util.Map<java.lang.String,java.lang.String>	getAllMethodResults() Method description
tigase.xml.Element	getClusterElement() Method description
java.util.List<tigase.xml.Element>	getDataPackets() Method description
java.lang.String	getFirstNode() Method description
java.lang.String	getMethodName() Method description
java.lang.String	getMethodParam(java.lang.String par_name) Method description
long	getMethodParam(java.lang.String par_name, long def) Method description
java.lang.String	getMethodResultVal(java.lang.String val_name) Method description
long	getMethodResultVal(java.lang.String val_name, long def) Method description
java.util.Set<java.lang.String>	getVisitedNodes() Method description
boolean	isVisitedNode(java.lang.String node_id) Method description
ClusterElement	nextClusterNode(java.lang.String node_id) Method description
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

Field description

See Also:

Constant Field Values

CLUSTER_CONTROL_EL_NAME

public static final java.lang.String CLUSTER_CONTROL_EL_NAME

Field description

See Also:

Constant Field Values

CLUSTER_DATA_EL_NAME

public static final java.lang.String CLUSTER_DATA_EL_NAME

Field description

See Also:

Constant Field Values

CLUSTER_EL_NAME

public static final java.lang.String CLUSTER_EL_NAME

Field description

See Also:

Constant Field Values

CLUSTER_METHOD_EL_NAME

public static final java.lang.String CLUSTER_METHOD_EL_NAME

Field description

See Also:

Constant Field Values

CLUSTER_METHOD_PAR_EL_NAME

public static final java.lang.String CLUSTER_METHOD_PAR_EL_NAME

Field description

See Also:

Constant Field Values

CLUSTER_METHOD_RESULTS_EL_NAME

public static final java.lang.String CLUSTER_METHOD_RESULTS_EL_NAME

Field description

See Also:

Constant Field Values

CLUSTER_METHOD_RESULTS_VAL_EL_NAME

public static final java.lang.String CLUSTER_METHOD_RESULTS_VAL_EL_NAME

Field description

See Also:

Constant Field Values

CLUSTER_NAME_ATTR

public static final java.lang.String CLUSTER_NAME_ATTR

Field description

See Also:

Constant Field Values

FIRST_NODE_EL_NAME

public static final java.lang.String FIRST_NODE_EL_NAME

Field description

See Also:

Constant Field Values

NODE_ID_EL_NAME

public static final java.lang.String NODE_ID_EL_NAME

Field description

See Also:

Constant Field Values

VISITED_NODES_EL_NAME

public static final java.lang.String VISITED_NODES_EL_NAME

Field description

See Also:

Constant Field Values

CLUSTER_CONTROL_PATH

public static final java.lang.String CLUSTER_CONTROL_PATH

Field description

See Also:

Constant Field Values

CLUSTER_METHOD_PATH

public static final java.lang.String CLUSTER_METHOD_PATH

Field description

See Also:

Constant Field Values

VISITED_NODES_PATH

public static final java.lang.String VISITED_NODES_PATH

Field description

See Also:

Constant Field Values

FIRST_NODE_PATH

public static final java.lang.String FIRST_NODE_PATH

Field description

See Also:

Constant Field Values

CLUSTER_METHOD_RESULTS_PATH

public static final java.lang.String CLUSTER_METHOD_RESULTS_PATH

Field description

See Also:

Constant Field Values

CLUSTER_DATA_PATH

public static final java.lang.String CLUSTER_DATA_PATH

Field description

See Also:

Constant Field Values

Constructor Detail

ClusterElement

public ClusterElement(tigase.xml.Element elem)

Creates a new ClusterElement instance.

Parameters:

elem -

ClusterElement

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

Constructs ...

Parameters:

from -

to -

type -

packet -

Method Detail

clusterElement

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

Method description

Parameters:

from -

to -

type -

Returns:

createClusterElement

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

Method description

Parameters:

from -

to -

type -

packet_from -

Returns:

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)

Method description

Parameters:

from -

to -

type -

method_name -

params -

Returns:

createForNextNode

public static ClusterElement createForNextNode(ClusterElement clel,
                                               java.util.List<tigase.xmpp.JID> cluster_nodes,
                                               tigase.xmpp.JID comp_id)

Method description

Parameters:

clel -

cluster_nodes -

comp_id -

Returns:

addDataPacket

public void addDataPacket(Packet packet)

Method description

Parameters:

packet -

addDataPacket

public void addDataPacket(tigase.xml.Element packet)

Method description

Parameters:

packet -

addMethodResult

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

Method description

Parameters:

key -

val -

addVisitedNode

public void addVisitedNode(java.lang.String node_id)

Method description

Parameters:

node_id -

createMethodResponse

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

Method description

Parameters:

from -

type -

results -

Returns:

createMethodResponse

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

Method description

Parameters:

from -

to -

type -

results -

Returns:

getAllMethodParams

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

Method description

Returns:

getAllMethodResults

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

Method description

Returns:

getClusterElement

public tigase.xml.Element getClusterElement()

Method description

Returns:

getDataPackets

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

Method description

Returns:

getFirstNode

public java.lang.String getFirstNode()

Method description

Returns:

getMethodName

public java.lang.String getMethodName()

Method description

Returns:

getMethodParam

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

Method description

Parameters:

par_name -

Returns:

getMethodParam

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

Method description

Parameters:

par_name -

def -

Returns:

getMethodResultVal

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

Method description

Parameters:

val_name -

Returns:

getMethodResultVal

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

Method description

Parameters:

val_name -

def -

Returns:

getVisitedNodes

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

Method description

Returns:

isVisitedNode

public boolean isVisitedNode(java.lang.String node_id)

Method description

Parameters:

node_id -

Returns:

nextClusterNode

public ClusterElement nextClusterNode(java.lang.String node_id)

Method description

Parameters:

node_id -

Returns:

parseMethodCall

protected void parseMethodCall(tigase.xml.Element method_call)