You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ws.apache.org by di...@apache.org on 2005/03/09 17:04:57 UTC

cvs commit: ws-site/targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/conversation/sessions package-frame.html package-summary.html SessionMonitor.html

dims        2005/03/09 08:04:57

  Added:       targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/conversation/sessions
                        package-frame.html package-summary.html
                        SessionMonitor.html
  Log:
  Update WSS4J web site.
  
  Revision  Changes    Path
  1.1                  ws-site/targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/conversation/sessions/package-frame.html
  
  Index: package-frame.html
  ===================================================================
  
  
    <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
    <html lang="en">
      <head>
        <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"></meta>
        <title>Apache WSS4J 1.0 Reference Package org.apache.ws.security.conversation.sessions</title>
        <link rel="stylesheet" href="../../../../../../stylesheet.css" type="text/css" title="style"></link>
      </head>
      <body>
  
        <h3>
          <a href="package-summary.html" target="classFrame">org.apache.ws.security.conversation.sessions</a>
        </h3>
  
        <h3>Classes</h3>
  
        <ul>
          
            <li>
              <a href="SessionMonitor.html" target="classFrame">SessionMonitor</a>
            </li>
          
        </ul>
  
      </body>
    </html>
  
  
  
  1.1                  ws-site/targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/conversation/sessions/package-summary.html
  
  Index: package-summary.html
  ===================================================================
  
  
    
  
    
      
  
      
  
      
  
    
        <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "DTD/xhtml1-transitional.dtd">
        <html lang="en">
          <head>
            <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"></meta>
            <title>Apache WSS4J 1.0 Reference Package </title>
            <link rel="stylesheet" href="../../../../../../stylesheet.css" type="text/css" title="style"></link>
          </head>
          <body>
  
            
        
        
  
        <div class="overview">
          <ul>
            <li>
              <a href="../../../../../../overview-summary.html">Overview</a>
            </li>
            <li class="selected">Package</li>
          </ul>
        </div>
        <div class="framenoframe">
          <ul>
            <li>
              <a href="../../../../../../index.html" target="_top">FRAMES</a>
            </li>
            <li>
              <a href="package-summary.html" target="_top">NO FRAMES</a>
            </li>
          </ul>
        </div>
  
        
  
      
        
        <h2>Package org.apache.ws.security.conversation.sessions</h2>
  
        <table class="summary">
          <thead>
            <tr>
              <th>Class Summary</th>
            </tr>
          </thead>
  
          <tbody>
            
              <tr>
                <td>
                  <a href="SessionMonitor.html" target="classFrame">SessionMonitor</a>
                </td>
              </tr>
            
          </tbody>
        </table>
  
      
        
        
  
        <div class="overview">
          <ul>
            <li>
              <a href="../../../../../../overview-summary.html">Overview</a>
            </li>
            <li class="selected">Package</li>
          </ul>
        </div>
        <div class="framenoframe">
          <ul>
            <li>
              <a href="../../../../../../index.html" target="_top">FRAMES</a>
            </li>
            <li>
              <a href="package-summary.html" target="_top">NO FRAMES</a>
            </li>
          </ul>
        </div>
  
        
  
      
      
  
            <hr></hr>
  
            Copyright &copy;  Apache Web Services. All Rights Reserved.
          </body>
        </html>
      
  
  
  
  1.1                  ws-site/targets/ws-fx/wss4j/docs/xref/org/apache/ws/security/conversation/sessions/SessionMonitor.html
  
  Index: SessionMonitor.html
  ===================================================================
  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
  <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>SessionMonitor xref</title>
  <link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
  </head>
  <body>
  <div id="overview"><a href="../../../../../../../apidocs/org/apache/ws/security/conversation/sessions/SessionMonitor.html">View Javadoc</a></div><pre>
  
  <a name="1" href="#1">1</a>   <em class="comment">/*</em>
  <a name="2" href="#2">2</a>   <em class="comment"> * Copyright  2003-2004 The Apache Software Foundation.</em>
  <a name="3" href="#3">3</a>   <em class="comment"> *</em>
  <a name="4" href="#4">4</a>   <em class="comment"> *  Licensed under the Apache License, Version 2.0 (the "License");</em>
  <a name="5" href="#5">5</a>   <em class="comment"> *  you may not use this file except in compliance with the License.</em>
  <a name="6" href="#6">6</a>   <em class="comment"> *  You may obtain a copy of the License at</em>
  <a name="7" href="#7">7</a>   <em class="comment"> *</em>
  <a name="8" href="#8">8</a>   <em class="comment"> *      <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
  <a name="9" href="#9">9</a>   <em class="comment"> *</em>
  <a name="10" href="#10">10</a>  <em class="comment"> *  Unless required by applicable law or agreed to in writing, software</em>
  <a name="11" href="#11">11</a>  <em class="comment"> *  distributed under the License is distributed on an "AS IS" BASIS,</em>
  <a name="12" href="#12">12</a>  <em class="comment"> *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
  <a name="13" href="#13">13</a>  <em class="comment"> *  See the License for the specific language governing permissions and</em>
  <a name="14" href="#14">14</a>  <em class="comment"> *  limitations under the License.</em>
  <a name="15" href="#15">15</a>  <em class="comment"> *</em>
  <a name="16" href="#16">16</a>  <em class="comment"> */</em>
  <a name="17" href="#17">17</a>  
  <a name="18" href="#18">18</a>  <strong>package</strong> <a href="../../../../../../org/apache/ws/security/conversation/sessions/package-summary.html">org.apache.ws.security.conversation.sessions</a>;
  <a name="19" href="#19">19</a>  
  <a name="20" href="#20">20</a>  <em>/**<em>*</em></em>
  <a name="21" href="#21">21</a>  <em> * Monitor for the conversation sessions</em>
  <a name="22" href="#22">22</a>  <em> * @author Ruchith Fernando</em>
  <a name="23" href="#23">23</a>  <em> * @version 1.0</em>
  <a name="24" href="#24">24</a>  <em> */</em>
  <a name="25" href="#25">25</a>  
  <a name="26" href="#26">26</a>  <strong>import</strong> org.apache.commons.logging.Log;
  <a name="27" href="#27">27</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
  <a name="28" href="#28">28</a>  <strong>import</strong> org.apache.ws.security.conversation.ConversationException;
  <a name="29" href="#29">29</a>  <strong>import</strong> org.apache.ws.security.conversation.ConversationSession;
  <a name="30" href="#30">30</a>  <strong>import</strong> org.apache.ws.security.util.Loader;
  <a name="31" href="#31">31</a>  
  <a name="32" href="#32">32</a>  <strong>import</strong> java.net.URL;
  <a name="33" href="#33">33</a>  <strong>import</strong> java.util.Enumeration;
  <a name="34" href="#34">34</a>  <strong>import</strong> java.util.Hashtable;
  <a name="35" href="#35">35</a>  <strong>import</strong> java.util.Properties;
  <a name="36" href="#36">36</a>  <strong>import</strong> java.util.Vector;
  <a name="37" href="#37">37</a>  
  <a name="38" href="#38">38</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../../../org/apache/ws/security/conversation/sessions/SessionMonitor.html">SessionMonitor</a> <strong>extends</strong> Thread {
  <a name="39" href="#39">39</a>  
  <a name="40" href="#40">40</a>      <strong>private</strong> Log log = LogFactory.getLog(SessionMonitor.<strong>class</strong>.getName());
  <a name="41" href="#41">41</a>  
  <a name="42" href="#42">42</a>      <em>/**<em>*</em></em>
  <a name="43" href="#43">43</a>  <em>     * Session lifetime in milliseconds</em>
  <a name="44" href="#44">44</a>  <em>     */</em>
  <a name="45" href="#45">45</a>      <strong>private</strong> <strong>long</strong> sessionLifetime;
  <a name="46" href="#46">46</a>  
  <a name="47" href="#47">47</a>      <em>/**<em>*</em></em>
  <a name="48" href="#48">48</a>  <em>     * </em>
  <a name="49" href="#49">49</a>  <em>     */</em>
  <a name="50" href="#50">50</a>      <strong>private</strong> <strong>long</strong> reapPeriodicity;
  <a name="51" href="#51">51</a>  
  <a name="52" href="#52">52</a>      <em>/**<em>*</em></em>
  <a name="53" href="#53">53</a>  <em>     *</em>
  <a name="54" href="#54">54</a>  <em>     */</em>
  <a name="55" href="#55">55</a>      <strong>private</strong> Hashtable sessionTable;
  <a name="56" href="#56">56</a>  
  <a name="57" href="#57">57</a>      <em>/**<em>*</em></em>
  <a name="58" href="#58">58</a>  <em>     *</em>
  <a name="59" href="#59">59</a>  <em>     */</em>
  <a name="60" href="#60">60</a>      <strong>private</strong> Vector expiredSessions = <strong>new</strong> Vector();
  <a name="61" href="#61">61</a>  
  <a name="62" href="#62">62</a>      <strong>private</strong> <strong>long</strong> lastReaped = System.currentTimeMillis();
  <a name="63" href="#63">63</a>  
  <a name="64" href="#64">64</a>      <strong>public</strong> <a href="../../../../../../org/apache/ws/security/conversation/sessions/SessionMonitor.html">SessionMonitor</a>(Hashtable sessionTable)
  <a name="65" href="#65">65</a>              throws <a href="../../../../../../org/apache/ws/security/conversation/ConversationException.html">ConversationException</a> {
  <a name="66" href="#66">66</a>          <em class="comment">//this.setPriority(Thread.MAX_PRIORITY);</em>
  <a name="67" href="#67">67</a>          <strong>try</strong> {
  <a name="68" href="#68">68</a>              Properties prop = getProperties(<span class="string">"SessionMonitor.properties"</span>);
  <a name="69" href="#69">69</a>              <strong>this</strong>.reapPeriodicity =
  <a name="70" href="#70">70</a>                      Long.parseLong(prop.getProperty(<span class="string">"org.apache.ws.security.converasation.session.reapPeriodicity"</span>));
  <a name="71" href="#71">71</a>              <strong>this</strong>.sessionLifetime =
  <a name="72" href="#72">72</a>                      Long.parseLong(prop.getProperty(<span class="string">"org.apache.ws.security.converasation.session.sessionLifetime"</span>));
  <a name="73" href="#73">73</a>              log.debug(<span class="string">"Reap periodicity from prop file: "</span> + <strong>this</strong>.reapPeriodicity);
  <a name="74" href="#74">74</a>              log.debug(<span class="string">"Session lifetime from prop file: "</span> + <strong>this</strong>.sessionLifetime);
  <a name="75" href="#75">75</a>          } <strong>catch</strong> (Exception e) {
  <a name="76" href="#76">76</a>              log.debug(<span class="string">"SessionMonitor: Cannot load SessionMonitor.properties using defaults: \n"</span>
  <a name="77" href="#77">77</a>                      + <span class="string">"org.apache.ws.security.converasation.session.reapInterval="</span>
  <a name="78" href="#78">78</a>                      + 60000
  <a name="79" href="#79">79</a>                      + <span class="string">"org.apache.ws.security.converasation.session.sessionLifetime"</span>
  <a name="80" href="#80">80</a>                      + 1800000);
  <a name="81" href="#81">81</a>              <strong>this</strong>.reapPeriodicity = 60000;
  <a name="82" href="#82">82</a>              <strong>this</strong>.sessionLifetime = 1800000;
  <a name="83" href="#83">83</a>          }
  <a name="84" href="#84">84</a>          <strong>this</strong>.sessionTable = sessionTable;
  <a name="85" href="#85">85</a>          log.debug(<span class="string">"Session monitor created"</span>);
  <a name="86" href="#86">86</a>      }
  <a name="87" href="#87">87</a>  
  <a name="88" href="#88">88</a>      <em>/**<em>*</em></em>
  <a name="89" href="#89">89</a>  <em>     * STOLEN FROM  org.apache.ws.security.components.crypto.CryptoFactory</em>
  <a name="90" href="#90">90</a>  <em>     * Gets the properties for SessionMonitor</em>
  <a name="91" href="#91">91</a>  <em>     * The functions loads the property file via</em>
  <a name="92" href="#92">92</a>  <em>     * {@link Loader.getResource(String)}, thus the property file</em>
  <a name="93" href="#93">93</a>  <em>     * should be accesible via the classpath</em>
  <a name="94" href="#94">94</a>  <em>     *</em>
  <a name="95" href="#95">95</a>  <em>     * @param propFilename the properties file to load</em>
  <a name="96" href="#96">96</a>  <em>     * @return a &lt;code>Properties&lt;/code> object loaded from the filename</em>
  <a name="97" href="#97">97</a>  <em>     */</em>
  <a name="98" href="#98">98</a>      <strong>private</strong> Properties getProperties(String propFilename) {
  <a name="99" href="#99">99</a>          Properties properties = <strong>new</strong> Properties();
  <a name="100" href="#100">100</a>         <strong>try</strong> {
  <a name="101" href="#101">101</a>             URL url = Loader.getResource(propFilename);
  <a name="102" href="#102">102</a>             properties.load(url.openStream());
  <a name="103" href="#103">103</a>             log.debug(<span class="string">"SessionMonitor.properties found"</span>);
  <a name="104" href="#104">104</a>         } <strong>catch</strong> (Exception e) {
  <a name="105" href="#105">105</a>             log.debug(<span class="string">"Cannot find SessionMonitor property file: "</span> + propFilename);
  <a name="106" href="#106">106</a>             <strong>throw</strong> <strong>new</strong> RuntimeException(<span class="string">"SessionMonitor: Cannot load properties: "</span> + propFilename);
  <a name="107" href="#107">107</a>         }
  <a name="108" href="#108">108</a>         <strong>return</strong> properties;
  <a name="109" href="#109">109</a>     }
  <a name="110" href="#110">110</a> 
  <a name="111" href="#111">111</a>     <strong>public</strong> <strong>void</strong> run() {
  <a name="112" href="#112">112</a>         <strong>while</strong> (<strong>true</strong>) {
  <a name="113" href="#113">113</a>             <strong>long</strong> now = System.currentTimeMillis();
  <a name="114" href="#114">114</a>             log.debug(<span class="string">"Diff: "</span> + (now - (lastReaped + reapPeriodicity)));
  <a name="115" href="#115">115</a>             <strong>if</strong> (now > (lastReaped + reapPeriodicity)) {
  <a name="116" href="#116">116</a>                 log.debug(<span class="string">"Special:Ruchith:Waiting to get session"</span>);
  <a name="117" href="#117">117</a>                 <strong>synchronized</strong> (<strong>this</strong>.sessionTable) {
  <a name="118" href="#118">118</a>                     log.debug(<span class="string">"Checking sessions"</span>);
  <a name="119" href="#119">119</a>                     Enumeration keys = <strong>this</strong>.sessionTable.keys();
  <a name="120" href="#120">120</a>                     <strong>while</strong> (keys.hasMoreElements()) {
  <a name="121" href="#121">121</a>                         String tempId = (String) keys.nextElement();
  <a name="122" href="#122">122</a>                         <a href="../../../../../../org/apache/ws/security/conversation/ConversationSession.html">ConversationSession</a> session =
  <a name="123" href="#123">123</a>                                 (<a href="../../../../../../org/apache/ws/security/conversation/ConversationSession.html">ConversationSession</a>) <strong>this</strong>.sessionTable.get(tempId);
  <a name="124" href="#124">124</a>                         <strong>synchronized</strong> (session) {
  <a name="125" href="#125">125</a>                             log.debug(<span class="string">"Session: "</span> + tempId);
  <a name="126" href="#126">126</a>                             <strong>if</strong> (<strong>this</strong>.isExpirable(session))
  <a name="127" href="#127">127</a>                                 <strong>this</strong>.expireSession(tempId);
  <a name="128" href="#128">128</a>                         }
  <a name="129" href="#129">129</a>                     }
  <a name="130" href="#130">130</a>                 }
  <a name="131" href="#131">131</a>                 lastReaped = now;
  <a name="132" href="#132">132</a>             }
  <a name="133" href="#133">133</a>             <strong>try</strong> {
  <a name="134" href="#134">134</a>                 sleep(reapPeriodicity / 2);
  <a name="135" href="#135">135</a>             } <strong>catch</strong> (InterruptedException e) {
  <a name="136" href="#136">136</a>                 log.debug(e.getMessage());
  <a name="137" href="#137">137</a>             }
  <a name="138" href="#138">138</a> 
  <a name="139" href="#139">139</a>         }
  <a name="140" href="#140">140</a> 
  <a name="141" href="#141">141</a>     }
  <a name="142" href="#142">142</a> 
  <a name="143" href="#143">143</a>     <strong>private</strong> <strong>boolean</strong> isExpirable(<a href="../../../../../../org/apache/ws/security/conversation/ConversationSession.html">ConversationSession</a> session) {
  <a name="144" href="#144">144</a>         <strong>long</strong> lastTouched = session.getLastTouched();
  <a name="145" href="#145">145</a>         <strong>if</strong> ((lastTouched + <strong>this</strong>.sessionL<strong>if</strong>etime) &lt; System.currentTimeMillis())
  <a name="146" href="#146">146</a>             <strong>return</strong> <strong>true</strong>;
  <a name="147" href="#147">147</a>         <strong>else</strong>
  <a name="148" href="#148">148</a>             <strong>return</strong> false;
  <a name="149" href="#149">149</a>     }
  <a name="150" href="#150">150</a> 
  <a name="151" href="#151">151</a>     <strong>private</strong> <strong>void</strong> expireSession(String identifier) {
  <a name="152" href="#152">152</a>         log.debug(<span class="string">"Expirign session "</span> + identifier);
  <a name="153" href="#153">153</a>         <strong>this</strong>.sessionTable.remove(identifier);
  <a name="154" href="#154">154</a>         <strong>this</strong>.expiredSessions.add(identifier);
  <a name="155" href="#155">155</a>     }
  <a name="156" href="#156">156</a> 
  <a name="157" href="#157">157</a>     <strong>public</strong> Vector getExpiredSessionIds() {
  <a name="158" href="#158">158</a>         <strong>return</strong> (Vector) <strong>this</strong>.expiredSessions.clone();
  <a name="159" href="#159">159</a>     }
  <a name="160" href="#160">160</a> 
  <a name="161" href="#161">161</a>     <strong>public</strong> Hashtable getLiveSessions() {
  <a name="162" href="#162">162</a>         <strong>return</strong> (Hashtable) <strong>this</strong>.sessionTable.clone();
  <a name="163" href="#163">163</a>     }
  <a name="164" href="#164">164</a> 
  <a name="165" href="#165">165</a> }
  </pre>
  <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
  </html>