You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by as...@apache.org on 2002/02/15 17:09:14 UTC

cvs commit: jakarta-turbine-stratum/docs/jcs JCSPackageInformation.html

asmuts      02/02/15 08:09:14

  Added:       docs/jcs JCSPackageInformation.html
  Log:
  some brief package documentation
  i will add to this
  
  Revision  Changes    Path
  1.1                  jakarta-turbine-stratum/docs/jcs/JCSPackageInformation.html
  
  Index: JCSPackageInformation.html
  ===================================================================
  <html>
  
  <head>
  <meta http-equiv=Content-Type content="text/html; charset=windows-1252">
  <meta name=Generator content="Microsoft Word 10 (filtered)">
  <title>JCS Package Information</title>
  
  <style>
  <!--
   /* Font Definitions */
   @font-face
  	{font-family:Garamond;
  	panose-1:2 2 4 4 3 3 1 1 8 3;}
   /* Style Definitions */
   p.MsoNormal, li.MsoNormal, div.MsoNormal
  	{margin:0in;
  	margin-bottom:.0001pt;
  	font-size:12.0pt;
  	font-family:"Times New Roman";}
  p.MsoPlainText, li.MsoPlainText, div.MsoPlainText
  	{margin:0in;
  	margin-bottom:.0001pt;
  	font-size:10.0pt;
  	font-family:"Courier New";}
  @page Section1
  	{size:8.5in 11.0in;
  	margin:1.0in 1.25in 1.0in 1.25in;}
  div.Section1
  	{page:Section1;}
  -->
  </style>
  
  </head>
  
  <body lang=EN-US>
  
  <div class=Section1>
  
  <p class=MsoNormal align=center style='text-align:center'><b><span
  style='font-family:Garamond'>JCS Package Information</span></b></p>
  
  <p class=MsoNormal align=center style='text-align:center'><b><span
  style='font-family:Garamond'>&nbsp;</span></b></p>
  
  <p class=MsoNormal><b><span style='font-family:Garamond'>Access</span></b></p>
  
  <p class=MsoNormal><span style='font-family:Garamond'>These packages house the
  classes that a user of JCS should need to access the cache.</span></p>
  
  <p class=MsoNormal><span style='font-family:Garamond'>&nbsp;</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\access</span></p>
  
  <p class=MsoPlainText><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText><b><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>Configuration</span></b></p>
  
  <p class=MsoPlainText><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>This package contains the cache configuration code.</span></p>
  
  <p class=MsoPlainText style='text-indent:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText style='text-indent:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\config</span></p>
  
  <p class=MsoPlainText><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText><b><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>Engine</span></b></p>
  
  <p class=MsoPlainText><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>These packages contain the code for the core of the cache: core
  interfaces, queues, and the cache hub.</span></p>
  
  <p class=MsoPlainText><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\engine</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\engine\behavior</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>(Interfaces used by the core and the
  auxiliary caches)</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\engine\control</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>(The primary cache classes and the hub.)</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\engine\group� </span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>(The group cache code.� Some classes here should
  be under control)</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\engine\memory</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>(Parent package for memory type plugins.)</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\engine\memory\behavior</span></p>
  
  <p class=MsoPlainText style='text-indent:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>(Interfaces for memory caches.)</span></p>
  
  <p class=MsoPlainText style='text-indent:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText style='text-indent:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\engine\memory\lru</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>(The primary memory plugin.)</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\engine\memory\mru</span></p>
  
  <p class=MsoPlainText><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText><b><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>Auxiliary Caches</span></b></p>
  
  <p class=MsoPlainText><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>Auxiliary caches generally fall into 3 types � disk, lateral, and
  remote.� Additional auxiliaries should be put into the appropriate parent
  package.� </span></p>
  
  <p class=MsoPlainText><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\behavior</span></p>
  
  <p class=MsoPlainText><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText><b><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>Disk</span></b></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\disk</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\disk\jisp</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\disk\hsql</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText><b><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>Lateral</span></b></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\lateral</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\lateral\socket</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\lateral\socket\tcp</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\lateral\socket\tcp\behavior</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\lateral\socket\tcp\utils</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\lateral\socket\udp</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\lateral\http</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\lateral\http\server</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\lateral\http\broadcast</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\lateral\http\remove</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText><b><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>Remote</span></b></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\remote</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\remote\server</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\remote\server\behavior</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\remote\server\group</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\remote\group</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\auxiliary\remote\behavior</span></p>
  
  <p class=MsoPlainText><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText><b><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>Utilities</span></b></p>
  
  <p class=MsoPlainText><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>These packages contain utility classes used by JCS.� Many can
  eventually be converted to commons utilities.</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\utils</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>...</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\utils\servlet</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>&nbsp;</span></p>
  
  <p class=MsoPlainText><b><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>Distributes Session</span></b></p>
  
  <p class=MsoPlainText><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>These utilities packages contain the distributed session code.</span></p>
  
  <p class=MsoPlainText style='margin-left:.5in'><span style='font-size:12.0pt;
  font-family:Garamond;color:black'>org\apache\stratum\jcs\utils\servlet\session</span></p>
  
  <p class=MsoPlainText><span style='font-size:12.0pt;font-family:Garamond;
  color:black'>&nbsp;</span></p>
  
  <p class=MsoNormal><b><span style='font-family:Garamond'>&nbsp;</span></b></p>
  
  </div>
  
  </body>
  
  </html>
  
  
  

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>