blitz_stable: docs/install_guide.html annotate

annotate docs/install_guide.html @ 23:b7e52953b7a6

Add some cache/memory statistics to help spot potential exhaustion and other tuning issues.

author	Dan Creswell <dan.creswell@gmail.com>
date	Fri, 28 Aug 2009 17:23:33 +0100
parents	3dc0c5604566
children

rev	line source
0 3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	2 <html>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	3 <head>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	4
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	5
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	6
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	7
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	8
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	9 <title>Blitz Installation Guide</title>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	10 <link rel="stylesheet" type="text/css" href="ssl.css">
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	11 </head>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	12
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	13
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	14 <body>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	15
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	16
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	17 <h1>Blitz Installation Guide</h1>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	18
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	19
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	20 <h2>Table of Contents</h2>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	21
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	22
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	23 <ol>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	24
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	25
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	26 <li><a href="#intro">Installation Choices</a></li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	27
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	28
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	29 <li><a href="#start">Getting Started</a></li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	30
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	31
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	32 <li><a href="#running">Running Blitz</a></li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	33
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	34
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	35 <li><a href="#memory">Memory Usage</a></li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	36
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	37
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	38 <li><a href="#admin">Administration</a></li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	39
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	40
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	41 <li><a href="#storagemodels">Appendix A - Storage
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	42 Models</a></li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	43
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	44
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	45 <li><a href="#appb">Appendix B - Configuration
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	46 Variables</a></li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	47
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	48
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	49 </ol>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	50
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	51
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	52 <a name="intro"></a>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	53 <h2>Installation Choices</h2>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	54
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	55 <h3>Installer</h3>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	56
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	57 <h4>GUI Install</h4>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	58
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	59 <p>If you're a new user or just want to get something up and
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	60 running, it's recommended that you download the installer which
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	61 includes a simple readme and does most of the configuration work for
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	62 you. The installer package is named <code>installer_pj_n_nn.jar</code>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	63 where <code>n_nn</code> is the release version number.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	64 Note that you'll still need to download and install the appropriate
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	65 version of JINI - see <a href="required_packages.html">required
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	66 packages</a>.  To run the installer use <code>java
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	67 -jar</code> which will display a simple GUI for gathering paths
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	68 and port settings.</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	69
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	70 <h4>Headless Install</h4>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	71
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	72 <p>The installer can also be run in
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	73 headless mode (command-line install) where one should specify the paths
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	74 and port settings as follows:</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	75
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	76
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	77 <pre>java -jar installer.jar JDK_Home Jini_Home Install_Dir HTTP_Port</pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	78
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	79
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	80 <p>or</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	81
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	82
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	83 <pre>java -jar installer.jar Jini_Home Install_Dir HTTP_Port </pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	84
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	85 <h3>Manual Install</h3>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	86
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	87 <p>If you're an experienced user who needs ultimate control over
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	88 installation layout or a developer seeking to make modifications to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	89 Blitz, you will wish to download either a binary or source distribution
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	90 and read the rest of this guide which will guide you through the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	91 installation process.</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	92
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	93
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	94 <a name="start"></a>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	95 <h2>Getting Started</h2>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	96
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	97
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	98 <p>First, ensure that you have installed the <a href="required_packages.html">required packages</a>.</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	99
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	100
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	101 <p>Second, if you are going to run blitz on JDK 1.4 you will need to modify the configuration files (located in the <code>config</code> directory), substituting <code>backport-util-concurrent50.jar</code> with <code>backport-util-concurrent.jar</code>.</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	102
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	103 <p>Blitz is fully integrated with JINI 2.1 so the preferred
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	104 method of startup is via the ServiceStarter. However, it's possible to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	105 run Blitz, for test purposes, in a standalone mode.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	106 </p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	107
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	108
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	109 <p>If you've downloaded the source distribution, please read the <a href="dev_guide.html">Developer's Guide</a> and ensure
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	110 you've compiled the Blitz <code>.jar</code>'s (once you've
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	111 done the necessary editing of <code>build.xml</code> you
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	112 can create the <code>.jar</code>'s with a simple <code>ant
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	113 all</code>.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	114 </p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	115
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	116
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	117 <h3>Assumptions</h3>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	118
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	119
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	120 For the purposes of the following examples, I assume that:
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	121 <ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	122
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	123
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	124 <li>You've unpacked the distribution in <code>/home/dan/src/jini/space</code></li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	125
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	126
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	127 <li>You've installed JINI 2.1 in <code>/home/dan/jini/jini2_1</code></li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	128
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	129
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	130 <li>You've installed Brian Murphy's starter kit in <code>/home/dan/jini/jini2_1/jini-start</code></li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	131
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	132
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	133 <li>Your machine's name is <code>yakuza</code></li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	134
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	135
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	136 </ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	137
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	138
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	139 <h3>Configuration Basics</h3>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	140
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	141
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	142 <p>Blitz is configured via a configuration file such as the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	143 example <a href="../config/blitz.config">blitz.config</a>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	144 file. This file contains options for determining security
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	145 configuration, remote functions and core functions such as the storage
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	146 model (see above).
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	147 </p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	148
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	149
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	150 <p>Blitz implements a concept of Storage Models which allows the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	151 user to customize the level of persistence provided. The default
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	152 setting is transient but, should you wish to change this, please read <a href="#storagemodels">Appendix A</a>.</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	153
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	154
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	155 <p>Additional configuration files are required for use with the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	156 ServiceStarter:</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	157
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	158
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	159 <ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	160
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	161
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	162 <li> <a href="../config/activatable-group.config">activatable-group.config</a>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	163 and <a href="../config/start-act-blitz.config">start-act-blitz.config</a>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	164 are examples of configuration files suitable for starting an
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	165 Activatable instance of Blitz.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	166
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	167
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	168 <li> <a href="../config/start-trans-blitz.config">start-trans-blitz.config</a>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	169 is an example configuration file suitable for starting a
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	170 non-Activatable instance of Blitz.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	171
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	172
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	173 </ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	174
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	175
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	176 <p>Regardless of the storage model chosen, Blitz may need to, at
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	177 least temporarily, persist it's state so ensure that you have properly
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	178 configured the appropriate entries in the core config file (these are
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	179 the configuration parameters <code>persistDir</code> and <code>logDir</code>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	180 in the configuration file). This is also important should you wish to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	181 "clean up" after a Blitz instance as you must delete the contents of
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	182 the persistence and log directories specified by the configuration
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	183 parameters.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	184 </p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	185
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	186
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	187 <p><b>Note: You <em>must</em> configure the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	188 persistence and log directories as described above. Other default
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	189 settings can be left alone though you should probably review the <code>initialGroups</code>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	190 setting (particularly if you choose to not use Brian Murphy's scripts).
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	191 You should also look at increasing the cache sizes to suit your
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	192 hardware.</b></p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	193
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	194
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	195 <hr align="center" size="3" width="70%">
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	196 <a name="running"></a>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	197 <h2>Running Blitz</h2>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	198
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	199
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	200 <h3>Starting JINI</h3>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	201
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	202
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	203 Before starting Blitz, you should start up the necessary JINI services.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	204 We can do this using Brian Murphy's starter kit scripts as follows:
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	205 <pre>cd /home/dan/jini/jini2_1/jini-start/example/scripts<br><br>./urun httpd<br><br>./urun jeri-transient-reggie<br><br>./urun jeri-transient-mahalo<br><br></pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	206
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	207
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	208 You may also find it useful to run the ServiceBrowser so you can check
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	209 that things are performing as expected:
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	210 <pre>./urun jeri-browser<br></pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	211
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	212
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	213 Now we must start a codebase server for Blitz:
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	214 <pre>./urun httpd -port 8081 -dir /home/dan/src/jini/space/lib<br></pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	215
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	216
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	217 If you plan to deploy an Activatable Blitz instance you will also need
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	218 to start either Phoenix or RMID. Assuming you choose to use RMID (note
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	219 that there are various security options that RMID doesn't support):
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	220 <pre>rmid -J-Djava.security.policy=/home/dan/src/jini/space/config/policy.all<br></pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	221
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	222
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	223 <h3>Using ServiceStarter</h3>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	224
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	225
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	226 <p>First, edit the configuration files as desired (you will
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	227 almost certainly need to alter the <code>blitzCodebase</code>,
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	228 <code>jiniRoot</code>, <code>dbLib</code>, <code>blitzRoot</code>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	229 variables and possibly <code>dbVersion</code>). To start
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	230 an Activatable Blitz instance:</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	231
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	232
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	233 <pre>cd /home/dan/src/jini/space/<br><br>java -Djava.security.policy=config/policy.all -jar /home/dan/jini/jini2_1/lib/start.jar config/start-act-blitz21.config<br></pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	234
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	235
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	236 Note that the default configuration files expect to create a log for
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	237 the shared activation group in <code>/tmp/sharedvm.log</code>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	238 which you will need to delete if you wish to start again from scratch,
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	239 re-registering the Blitz instance etc.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	240 To start a non-activatable instance:
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	241 <pre>cd /home/dan/src/jini/space/<br><br>java -Djava.security.policy=config/policy.all -jar /home/dan/jini/jini2_1/lib/start.jar config/start-trans-blitz21.config<br></pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	242
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	243
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	244 <hr align="center" size="3" width="70%">
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	245 <h3>A Word on Configuration Files</h3>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	246
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	247
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	248 <p>Example configurations for JINI 2.1 can be found in the <code>config</code>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	249 directory and have a <code>21</code> subscript. Those
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	250 configurations without the subscript are examples of scripts which
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	251 provide backward compatibility with JINI 2.0. Note that existing Blitz
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	252 scripts from releases prior to Blitz Pure Java 1.13 will need
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	253 modifications in line with these examples.</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	254
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	255
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	256 <h2><a name="memory">Memory Usage</a></h2>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	257
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	258
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	259 <p><a name="memory">For background you should read
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	260 these:
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	261 </a></p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	262
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	263
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	264 <ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	265
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	266
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	267 <li><a href="http://jroller.com/page/dancres?entry=javaspaces_fallacies">JavaSpaces
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	268 Fallacies</a></li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	269
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	270
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	271 <li><a href="http://www.jroller.com/page/dancres?entry=are_you_leaking_memory">Are
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	272 You Sure You're Leaking Memory?</a></li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	273
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	274
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	275 </ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	276
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	277
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	278 <p>Blitz uses it's cache to hold both live and dead (taken or
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	279 lease expired) Entry's. It only clears it's cache once it is full.</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	280
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	281
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	282 <p>i.e. If you set the cache size to 100 and you have only five
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	283 entry's with one writer and one taker, Blitz will have a cache
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	284 containing 5 live entries and 95 dead ones after things have run for a
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	285 while.</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	286
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	287
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	288 <p><b>Important:</b> Each type of Entry is given it's
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	289 <em>own</em> cache (i.e. there isn't one cache shared
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	290 across all Entry's of all types). So approximate total memory usage (to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	291 get an accurate figure would require estimating garbage requirements
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	292 etc) is:</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	293
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	294
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	295 <pre>memory = 0;<br>for (X in all Entry types) {<br> memory = memory + (cache_size * size_of X)<br>}<br><br>memory = memory + Db database cache size</pre>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	296
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	297
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	298 <p>Where Db database cache size is specified in the configuration
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	299 file under dbCache</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	300
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	301
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	302 <p>Thus in OutOfMemory situations, the correct approach is to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	303 reduce entry cache size or the db cache or increase available JVM heap
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	304 or a combination of the three. Note that in the case of a persistent
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	305 Blitz, you should also consider enabling log file serialization stream
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	306 reset by setting the first boolean parameter to the Persistent class
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	307 constructor (defined as the storageModel in the configuration file) to <code>true</code>.</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	308
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	309
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	310 <p>Note that there is a tool (EntrySizer) in the Blitz
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	311 distribution (see Extensions in the documentation for your chosen
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	312 version) which can be used to compute the approximate size of an Entry
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	313 as it will be stored in Blitz's cache.</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	314
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	315
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	316 <p>Note also that you can specify individual cache sizes per
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	317 Entry type using EntryConstraint examples of which can be found in the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	318 configuration files. A good basic approach to using these constraints
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	319 would be to set <code>entryReposCacheSize</code> to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	320 something small like 256 or 512 and then use the EntryConstraints to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	321 allocate bigger caches (e.g. 1024, 4096) to specific Entry types.</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	322
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	323
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	324 <p>In cases where you are submitting Blitz to high load for
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	325 sustained periods of time and the CPU usage is close to 100%, consider
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	326 enabling throttling to prevent overflow of internal queues. See <code>eventQueueBound</code>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	327 and <code>taskQueueBound</code> in <a href="#appb">Appendix
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	328 B - Configuration Variables</a>.</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	329
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	330
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	331 <a name="admin"></a>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	332 <h2>Administration</h2>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	333
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	334
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	335 <p>Blitz supports <code>JoinAdmin</code>, <code>DestroyAdmin</code>,
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	336 <code>JavaSpaceAdmin</code> and two custom management
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	337 interfaces (<code>BlitzAdmin</code> and <code>StatsAdmin</code>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	338 and, therefore, can be managed by a variety of browser tools.</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	339
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	340
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	341 <p>The first time a Blitz instance is started, it loads it's JINI
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	342 configuration information such as lookup groups and locators from it's
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	343 configuration file. These are then stored in a binary metadata file
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	344 along with the <code>serviceID</code> and various other
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	345 pieces of runtime information. <b>Future re-starts of the Blitz
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	346 instance will read the configuration information from the binary
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	347 metadata file (unless the StorageModel is Transient, in which case all
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	348 state is lost and the configuration file will be read again)</b>.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	349 Thus, further configuration changes in respect of JINI state must be
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	350 done via JoinAdmin. Other non-JINI configuration information can be
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	351 changed in the configuration file and will take effect the next time
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	352 the Blitz instance is restarted.</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	353
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	354
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	355 <p><code>DestroyAdmin::destroy</code> is usually
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	356 defined to shutdown the service instance and remove all it's persistent
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	357 state. As a convenience, Blitz provides a configuration variable, <code>compliantDestroy</code>,
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	358 which can be used to specify whether a Blitz instance should delete or
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	359 retain it's state when carrying out a destroy request. When <code>compliantDestroy</code>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	360 is <code>false</code> Blitz simply shut's down in response
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	361 to a destroy call. If <code>compliantDestroy</code> is <code>true</code>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	362 Blitz will delete all state before shutting down. If <code>compliantDestroy</code>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	363 is not specified in the configuration file, the default is to retain
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	364 state when <code>destroy</code> is invoked.</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	365
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	366
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	367 <p>It is my belief that, as well as destroy, there should be an
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	368 additional standardized method to trigger a shutdown whilst retaining
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	369 state. As there is no such standard, the <code>BlitzAdmin</code>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	370 interface provides such a method.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	371 </p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	372
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	373
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	374 <hr align="center" size="3" width="70%">
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	375 <a name="storagemodels"></a>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	376 <h2>Appendix A - Storage Models</h2>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	377
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	378
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	379 <p>As of Blitz 2.0, it is possible to configure a number of
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	380 different persistence profiles. They are currently:</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	381
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	382
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	383 <ol>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	384
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	385
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	386 <li><a href="javadocs/org/dancres/blitz/config/Persistent.html">Persistent</a>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	387 - In this mode, Blitz behaves like a fully persistent JavaSpace such as
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	388 the persistent version of Outrigger.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	389
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	390
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	391 <li><a href="javadocs/org/dancres/blitz/config/Transient.html">Transient</a>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	392 - (default setting) causes Blitz to act like a disk-backed cache. In
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	393 this mode, Blitz behaves like the transient version of Outrigger. No
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	394 logging is performed and, when Blitz is restarted, all state (including
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	395 Join state etc.) is lost. Memory-only transient implementations can
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	396 halt with <code>OutOfMemoryError</code>'s if they are
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	397 over-filled. Blitz avoids this problem by swapping to disk when the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	398 number of stored <code>Entry</code>'s overflows it's
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	399 available cache space. Obviously, performance will degrade relative to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	400 the amount of swapping Blitz is required to perform. When the caches
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	401 are sufficiently large, Blitz will make minimal use of disk, yielding
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	402 maximal performance.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	403
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	404
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	405 <li><a href="javadocs/org/dancres/blitz/config/TimeBarrierPersistent.html">TimeBarrierPersistent</a>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	406 - provides a performance versus persistence QoS tradeoff. In this mode,
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	407 changes made more than a certain number of milliseconds ago are
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	408 guarenteed to be persistent. More recent changes are <em>not
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	409 guarenteed</em> persistent but <em>may be</em>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	410 persistent. This mode provides the developer with a means of balancing
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	411 persistence needs against performance.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	412
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	413
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	414 </ol>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	415
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	416
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	417 <p>The actual model used is determined by the value of the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	418 configuration variable <code>storageModel</code>. The
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	419 standard configuration file contains example settings for all three
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	420 modes which should provide reasonable starting points for more precise
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	421 tuning. For more details on the exact settings for each model see the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	422 Javadoc for <code>org.dancres.blitz.config.Persistent</code>,
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	423 <code>org.dancres.blitz.config.Transient</code> and <code>org.dancres.blitz.config.TimeBarrierPersistent</code>.</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	424
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	425
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	426 <hr align="center" size="3" width="70%">
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	427 <a name="appb"></a>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	428 <h2>Appendix B - Configuration Variables</h2>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	429
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	430
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	431 <h3>Basic Setup</h3>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	432
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	433
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	434 <ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	435
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	436
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	437 <li><i>persistDir</i>=<string> - the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	438 directory in which blitz will keep checkpointed state.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	439
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	440
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	441 <li><i>logDir</i>=<string> - the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	442 directory in which blitz will keep it's log files. If all log files are
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	443 present, Blitz can reconstitute the checkpointed state.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	444
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	445
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	446 <li><i>storageModel</i>=<type> - see
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	447 Appendix A.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	448
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	449
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	450 </ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	451
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	452
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	453 <h3>JINI-related options</h3>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	454
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	455
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	456 <ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	457
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	458
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	459 <li><i>name</i>=<string> - configures
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	460 the name of the Blitz Instance. This value is made available on the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	461 proxy as a Name attribute</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	462
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	463
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	464 <li><i>loginContext</i>=<LoginContext>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	465 - sets the identity the Blitz instance will take on when it starts up.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	466 Many security configurations will require this to be set.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	467
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	468
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	469 <li><i>compliantDestroy</i>=<Boolean>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	470 - see Administration section above.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	471
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	472
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	473 <li><i>initialGroups</i>=<String[]> -
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	474 defines the collection of LUS groups under which a Blitz instance will
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	475 register on initial startup (after initial startup, groups are held in
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	476 an internal database which can be reconfigured via JoinAdmin.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	477
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	478
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	479 <li><i>initialLocators</i>=<LookupLocator[]>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	480 - set this to configure registration with specific LUS. This value is
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	481 only used for initial startup as initialGroups.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	482
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	483
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	484 <li><i>initialAttrs</i>=<Entry[]> -
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	485 the Entry attributes to make available on the proxy as part of initial
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	486 startup. Behaviour is the same as for initialGroups and initialLocators.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	487
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	488
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	489 <li><i>serverExporter</i>=<Exporter>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	490 -
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	491 configures the JERI endpoint to be used by the Blitz instance. Allows
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	492 for configuration of tcp, ssl, https etc as the transport.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	493
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	494
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	495 <li><i>*preparer</i>=<ProxyPreparer>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	496 - defines the proxy preparer to be used to verify various remote
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	497 references which may be passed to a Blitz instance.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	498
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	499
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	500 <li><i>*recoveredPreparer</i>=<ProxyPreparer>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	501 - defines the proxy preparer to be used to verify a remote instance
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	502 recovered from the log/checkpoint storage during a restart.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	503
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	504
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	505 <li><span style="font-style: italic;">loopbackTxnExporter</span>=<Exporter>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	506 - configures and enables the loopback transaction manager which can be
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	507 used to accelerate transactions against this Blitz instance.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	508  Note
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	509 it cannot be used to co-ordinate transactions amongst multiple
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	510 participants nor does it yet support security options. <span style="font-weight: bold;">[BETA]</span></li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	511
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	512
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	513 </ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	514
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	515
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	516 <h3>Notify Subsystem</h3>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	517
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	518
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	519 <ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	520
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	521 <li><i>syncNotifyOnWrite</i>=<boolean> - when enabled forces writes to wait
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	522 until all associated events have been processed. IfExists is a significant performance drain and by default Blitz aggressively optimizes event delivery for those calls such that events from writes close to the resolution point may be ignored. If you are using IfExists and require completely deterministic behaviour, enable this option. For those not using *IfExists leave this option disabled for better performance.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	523
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	524 <li><i>maxEventProcessors</i>=<int> -
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	525 defines the maximum number of threads to be used to empty the notify
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	526 event queue and perform matching against notify templates. Defaults to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	527 1.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	528
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	529
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	530 <li><i>eventgenSaveInterval</i>=<int>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	531 - the number of events to be generated against an event registration
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	532 before logging to disk.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	533
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	534
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	535 <li><i>eventgenRestartJump</i>=<int>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	536 - the number by which to advance the sequence number of an event
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	537 registration at recovery time. This "jump" is designed to allow an
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	538 end-user application to detect the fact that recovery has been
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	539 performed and that events may have been lost/never generated.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	540
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	541
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	542 </ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	543
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	544
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	545 <h3>Lease Subsystem</h3>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	546
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	547
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	548 <p>Allows control of leasing operation such as assigning a
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	549 maximum allowable lease time.</p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	550
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	551
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	552 <ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	553
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	554
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	555 <li><i>entryLeaseBound</i>=<long> -
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	556 sets the maximum lease permissible for an Entry. Set this to zero to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	557 allow Lease.FOREVER</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	558
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	559
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	560 <li><i>notifyLeaseBound</i>=<long> -
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	561 sets the maximum lease permissible for a notify registration. Set this
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	562 to zero to allow Lease.FOREVER</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	563
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	564
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	565 <li><i>leaseReapInterval</i>=<long> -
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	566 the time between active scans for lease expired resources. Value should
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	567 be ms (0 disables active cleanup). Normally, Blitz uses read/take
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	568 activity to do cleanup (passive). If memory or disk resource is scarce,
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	569 configure this to non-zero to activate more aggressive cleaning (which,
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	570 in turn, is more CPU aggressive). Alternatively, you can enable manual
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	571 lease cleanup (via execution of <code>org.dancres.blitz.tools.RequestReap</code>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	572 by setting this to <code>org.dancres.blitz.lease.LeaseReaper.MANUAL_REAP</code></li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	573
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	574
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	575 </ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	576
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	577
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	578 <h3>Advanced Setup</h3>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	579
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	580
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	581 <ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	582
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	583
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	584 <li><i>loadBackoff</i>=<int[]> -
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	585 configures the deadlock avoidance timings for loading entry's. Requires
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	586 a two int array consisting of base_backoff and the random jitter to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	587 apply to that backoff.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	588
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	589
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	590 <li><i>maxOidAllocators</i>=<int> -
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	591 the maximum number of allocators to use per Entry type for id
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	592 generation. Ids are never reused thus a small number of allocators may
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	593 run out of ids in highly concurrent take/write scenarios. More
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	594 allocators also improves concurrency.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	595
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	596
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	597 <li><i>maxWriteThreads</i>=<int> -
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	598 should not be changed from the default value of 1.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	599
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	600
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	601 <li><i>threadKeepAlive</i>=<long> -
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	602 ms before a write thread will be killed rather than pooled.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	603
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	604
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	605 <li><i>maxTaskThreads</i>=<int> - the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	606 maximum number of threads allowed for a task pool.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	607
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	608
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	609 <li><i>entryReposReadahead</i>=<int>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	610 - the maximum number of Entry's to fault in should the cache provide no
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	611 matches. Zero means readahead should be disabled. This is a global
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	612 setting which can be overidden with individual Entry constraints - see
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	613 the Javadoc for <code>org.dancres.blitz.config.EntryConstraint</code>.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	614
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	615 <li><i>agents</i>=<ColocatedAgent[]>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	616 - is an array of initializers to be run against the Blitz proxy before it
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	617 is published via a join manager to lookup services. See the javadoc for
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	618 <code>org.dancres.blitz.remote.user.ColocatedAgent</code>.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	619
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	620 <li><i>updateContents</i>=<boolean> - Determines whether the contents methods on <code>JavaSpaceAdmin</code> and <code>JavaSpace05</code> update their working match sets with entry's written after the set was created. Note enabling this can mean that one never reaches the end of the match set or that the match set overflows memory if it fills faster than a client empties it.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	621
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	622 </ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	623
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	624
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	625 <h3>Memory Management</h3>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	626
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	627
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	628 <ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	629
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	630
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	631 <li><i>desiredPendingWrites</i>=<int>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	632 - the number of writes to batch for disk update.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	633
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	634
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	635 <li><i>throttlePendingWrites</i>=<int>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	636 - the maximum number of writes to batch for disk update. If the queue
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	637 fills beyond this threshold (perhaps due to slow disks) throttling is
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	638 applied to foreground operations whilst disk catches up.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	639
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	640
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	641 <li><i>dbCache</i>=<int> - the max
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	642 size of cache Db is allowed (bigger being better).</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	643
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	644
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	645 <li><i>maxDbTxns</i>=<int> - the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	646 maximum number of transactions Db should support concurrently. Under
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	647 highly concurrent loads, increase this number.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	648
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	649
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	650 <li><i>entryReposCacheSize</i>=<int>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	651 - the maximum number of Entry's (per type) to cache. This is a global
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	652 setting which can be overidden with individual Entry constraints - see
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	653 the Javadoc for <code>org.dancres.blitz.config.EntryConstraint</code>.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	654
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	655
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	656 <li><i>eventQueueBound</i>=<int> -
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	657 limits the maximum size of the notify event queue - once full, writing
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	658 threads will be throttled down to prevent overflow. Defaults to
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	659 0(disabled)</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	660
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	661
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	662 <li><i>taskQueueBound</i>=<int> -
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	663 limits the maximum size of the task queue (used for processing new
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	664 writes against blocked takes or reads) - once full, writing threads
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	665 will be throttled down to prevent overflow. Defaults to 0(disabled)</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	666
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	667
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	668 </ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	669
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	670
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	671 <h3>Debug Options</h3>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	672
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	673
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	674 <ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	675
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	676
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	677 <li><i>ignoreLogConfig</i>=<Boolean>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	678 - when true, causes Blitz to ignore any logger <code>Level</code>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	679 entrys in it's configuration file. This allows a developer to use the
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	680 standard logger configuration approach when appropriate.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	681
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	682
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	683 <li><i>logCkpts</i>=<Boolean> - if
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	684 true, causes Blitz to generate a log message at each checkpoint</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	685
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	686
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	687 <li><i>statsDump</i>=<long> - pause in milliseconds which determines how often the stats are dumped to console. Setting this to zero disables stats dumping.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	688
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	689
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	690 <li><i>stats</i>=<Switch[]> - Defines
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	691 the default
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	692 settings for stats gathering. See the Javadoc for <code>org.dancres.blitz.stats</code>.
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	693 This information is processed by Dashboard.</li>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	694
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	695
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	696 </ul>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	697
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	698
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	699 <p></p>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	700
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	701
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	702 <div align="center"><a href="../index.html">Back
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	703 to Documentation</a></div>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	704
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	705
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	706 </body>
3dc0c5604566 Initial checkin of blitz 2.0 fcs - no installer yet. Dan Creswell <dan.creswell@gmail.com> parents: diff changeset	707 </html>

Mercurial > hg > blitz_stable

annotate docs/install_guide.html @ 23:b7e52953b7a6