Quellcode-Bibliothek

^© Kompilation durch diese Firma

[Weder Korrektheit noch Funktionsfähigkeit der Software werden zugesichert.]

Datei: cluster.xml Sprache: XML

Original von: Apache^©

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE document [
 <!ENTITY project SYSTEM "project.xml">
]>
<document url="cluster.html">

 &project;

 <properties>
 <author email="[email protected]">Filip Hanik</author>
 <title>The Cluster object</title>
 </properties>

<body>

<section name="Table of Contents">
<toc/>
</section>

<section name="Introduction">
 
 The tomcat cluster implementation provides session replication, context attribute replication and
 cluster wide WAR file deployment.
 While the <code>Cluster</code> configuration is fairly complex, the default configuration will work
 for most people out of the box. 
 The Tomcat Cluster implementation is very extensible, and hence we have exposed a myriad of options,
 making the configuration seem like a lot, but don't lose faith, instead you have a tremendous control
 over what is going on.
</section>
<section name="Security">

The cluster implementation is written on the basis that a secure, trusted
network is used for all of the cluster related network traffic. It is not safe
to run a cluster on a insecure, untrusted network.

There are many options for providing a secure, trusted network for use by a
Tomcat cluster. These include:
<ul>
 <li>private LAN</li>
 <li>a Virtual Private Network (VPN)</li>
 <li>IPSEC</li>
</ul>

The <a href="cluster-interceptor.html#org.apache.catalina.tribes.group.interceptors.EncryptInterceptor_Attributes">EncryptInterceptor</a>
provides confidentiality and integrity protection but it does not protect
against all risks associated with running a Tomcat cluster on an untrusted
network, particularly DoS attacks.

</section>
<section name="Engine vs Host placement">
 
 You can place the <code><Cluster></code> element inside either the <code><Engine></code>
 container or the <code><Host></code> container. 
 Placing it in the engine, means that you will support clustering in all virtual hosts of Tomcat,
 and share the messaging component. When you place the <code><Cluster></code> inside the <code><Engine></code>
 element, the cluster will append the host name of each session manager to the managers name so that two contexts with
 the same name but sitting inside two different hosts will be distinguishable.
 
</section>
<section name="Context Attribute Replication">
 To configure context attribute replication, simply do this by swapping out the context implementation
 used for your application context.
 <source><Context className="org.apache.catalina.ha.context.ReplicatedContext"/></source>
 
 This context extends the Tomcat <code><a href="context.html">StandardContext</a></code>
 so all the options from the <a href="context.html">base implementation</a> are valid.
 
</section>
<section name="Nested Components">
 <a href="cluster-manager.html">Manager</a>: 
 The session manager element identifies what kind of session manager is used in this cluster implementation.
 This manager configuration is identical to the one you would use in a regular <code><a href="context.html#Nested_Components"><Context></a></code> configuration.
 The default value is the <code>org.apache.catalina.ha.session.DeltaManager</code> that is closely coupled with
 the <code>SimpleTcpCluster</code> implementation. Other managers like the <code>org.apache.catalina.ha.session.BackupManager</code>
 are/could be loosely coupled and don't rely on the SimpleTcpCluster for its data replication.
 
 <a href="cluster-channel.html">Channel</a>: 
 The Channel and its sub components are all part of the IO layer
 for the cluster group, and is a module in it's own that we have nick named "Tribes"
 
 Any configuring and tuning of the network layer, the messaging and the membership logic
 will be done in the channel and its nested components.
 You can always find out more about <a href="../tribes/introduction.html">Apache Tribes</a>
 
 <a href="cluster-valve.html">Valve</a>: 
 The Tomcat Cluster implementation uses <code>Tomcat <a href="valve.html">Valves</a></code> to
 track when requests enter and exit the servlet container. It uses these valves to be able to make
 intelligent decisions on when to replicate data, which is always at the end of a request.
 
 <a href="cluster-deployer.html">Deployer</a>: 
 The Deployer component is the Tomcat Farm Deployer. It allows you to deploy and undeploy applications
 cluster wide.
 
 <a href="cluster-listener.html">ClusterListener</a>: 
 ClusterListener's are used to track messages sent and received using the SimpleTcpCluster.
 If you wish to track messages, you can add a listener here, or you can add a valve to the channel object.
 
</section>

<section name="Attributes">
 <subsection name="SimpleTcpCluster Attributes">
 <attributes>
 <attribute name="className" required="true">
 The main cluster class, currently only one is available,
 <code>org.apache.catalina.ha.tcp.SimpleTcpCluster</code>
 
 </attribute>
 <attribute name="channelSendOptions" required="true">
 The Tribes channel send options, default is <code>8</code>. 
 This option is used to set the flag that all messages sent through the
 SimpleTcpCluster uses. The flag decides how the messages are sent, and is a simple logical OR.

 <source>int options = Channel.SEND_OPTIONS_ASYNCHRONOUS |
 Channel.SEND_OPTIONS_SYNCHRONIZED_ACK |
 Channel.SEND_OPTIONS_USE_ACK;</source>
 Some of the values are: 
 <code>Channel.SEND_OPTIONS_SYNCHRONIZED_ACK = 0x0004</code> 
 <code>Channel.SEND_OPTIONS_ASYNCHRONOUS = 0x0008</code> 
 <code>Channel.SEND_OPTIONS_USE_ACK = 0x0002</code> 
 So to use ACK and ASYNC messaging, the flag would be <code>10</code> (8+2)
 
 Note that if you use ASYNC messaging it is possible for update messages
 for a session to be processed by the receiving nodes in a different order
 to the order in which they were sent.
 
 
 The various <code>channelSendOptions</code> values offer a tradeoff
 between throughput on the sending node and the reliability of
 replication should the sending or receiving node(s) fail. Here are
 some common options. "Message" could be any message sent between nodes,
 but only session-change messages are considered, here.
 
 
 <code>channelSendOptions="8"</code> / <code>channelSendOptions="async"</code>
 As far as the sender is concerned, the message is "sent"
 as soon as it has been placed in the queue on the sender for
 transmission to the other nodes. The message may not reach any or all
 of the recipient nodes and may not be successfully processed on any
 nodes that it does reach. This option offers the highest throughput on
 the sender but the least reliability, as the triggering request will
 complete without any knowledge of the success/failure of the session
 replication.
 
 
 <code>channelSendOptions="2"</code> / <code>channelSendOptions="use_ack"</code>
 The sender will block the completion of the current request until all
 of the receiving nodes have acknowledged that they have received the
 message, but have not necessarily processed that message. This option
 will result in lower throughput on the sending node, because the message
 must be transmitted and the acknowledgement received, but the
 reliability is greater than the asynchronous model.
 
 
 <code>channelSendOptions="6"</code> / <code>channelSendOptions="sync,use_ack"</code>
 The sender will block the completion of the current request until
 all of the receiving nodes have acknowledged that they have received
 and processed the message. This option will have the lowest
 throughput (of these three) but the greatest reliability.
 
 
 You may also set these options as a comma separated string, e.g. "async, multicast", which
 will be translated into <code>Channel.SEND_OPTIONS_ASYNCHRONOUS | Channel.SEND_OPTIONS_MULTICAST</code>
 
 The valid option names are "asynchronous" (alias "async"), "byte_message" (alias "byte")
 , "multicast", "secure", "synchronized_ack" (alias "sync"), "udp", "use_ack"
 
 </attribute>
 <attribute name="channelStartOptions" required="false">
 Sets the start and stop flags for the <Channel> object used by the cluster.
 The default is <code>Channel.DEFAULT</code> which starts all the channel services, such as
 sender, receiver, membership sender and membership receiver.
 The following flags are available today:
 <source>Channel.DEFAULT = Channel.SND_RX_SEQ (1) |
 Channel.SND_TX_SEQ (2) |
 Channel.MBR_RX_SEQ (4) |
 Channel.MBR_TX_SEQ (8);</source>
 When using the static membership service
 <code>org.apache.catalina.tribes.membership.StaticMembershipService</code>
 you must ensure that this attribute is configured to use the default
 value.
 </attribute>

 <attribute name="heartbeatBackgroundEnabled" required="false">
 Flag whether invoke channel heartbeat at container background thread. Default value is false.
 Enable this flag don't forget to disable the channel heartbeat thread.
 
 </attribute>

 <attribute name="notifyLifecycleListenerOnFailure" required="false">
 Flag whether notify LifecycleListeners if all ClusterListener couldn't accept channel message.
 Default value is false.
 
 </attribute>
 </attributes>
 </subsection>
</section>
</body>
</document>

¤ Dauer der Verarbeitung: 0.21 Sekunden (vorverarbeitet) ¤

Download des Quellennavigators
Download des sprechenden Kalenders
in der Quellcodebibliothek suchen

Haftungshinweis

Die Informationen auf dieser Webseite wurden nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit, noch Qualität der bereit gestellten Informationen zugesichert.

Bemerkung:

Die farbliche Syntaxdarstellung ist noch experimentell.