| <!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>SecureRemoteInvocationFactory xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../../apidocs/org/apache/shiro/spring/remoting/SecureRemoteInvocationFactory.html">View Javadoc</a></div><pre> |
| |
| <a name="1" href="#1">1</a> <em class="jxr_comment">/*</em> |
| <a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a name="9" href="#9">9</a> <em class="jxr_comment"> *</em> |
| <a name="10" href="#10">10</a> <em class="jxr_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="11" href="#11">11</a> <em class="jxr_comment"> *</em> |
| <a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em> |
| <a name="18" href="#18">18</a> <em class="jxr_comment"> */</em> |
| <a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.spring.remoting; |
| <a name="20" href="#20">20</a> |
| <a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.aopalliance.intercept.MethodInvocation; |
| <a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.SecurityUtils; |
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.Session; |
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.mgt.NativeSessionManager; |
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.mgt.SessionKey; |
| <a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.session.mgt.SessionManager; |
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.subject.Subject; |
| <a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> org.slf4j.Logger; |
| <a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> org.slf4j.LoggerFactory; |
| <a name="30" href="#30">30</a> <strong class="jxr_keyword">import</strong> org.springframework.remoting.support.DefaultRemoteInvocationFactory; |
| <a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.springframework.remoting.support.RemoteInvocation; |
| <a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.springframework.remoting.support.RemoteInvocationFactory; |
| <a name="33" href="#33">33</a> |
| <a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> java.io.Serializable; |
| <a name="35" href="#35">35</a> |
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * A {@link RemoteInvocationFactory} that passes the session ID to the server via a</em> |
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * {@link RemoteInvocation} {@link RemoteInvocation#getAttribute(String) attribute}.</em> |
| <a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * This factory is the client-side part of</em> |
| <a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * the Shiro Spring remoting invocation. A {@link SecureRemoteInvocationExecutor} should</em> |
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * be used to export the server-side remote services to ensure that the appropriate</em> |
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * Subject and Session are bound to the remote thread during execution.</em> |
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * @since 0.1</em> |
| <a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="46" href="#46">46</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../org/apache/shiro/spring/remoting/SecureRemoteInvocationFactory.html">SecureRemoteInvocationFactory</a> <strong class="jxr_keyword">extends</strong> DefaultRemoteInvocationFactory { |
| <a name="47" href="#47">47</a> |
| <a name="48" href="#48">48</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Logger log = LoggerFactory.getLogger(SecureRemoteInvocationFactory.<strong class="jxr_keyword">class</strong>); |
| <a name="49" href="#49">49</a> |
| <a name="50" href="#50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SESSION_ID_KEY = SecureRemoteInvocationFactory.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">".SESSION_ID_KEY"</span>; |
| <a name="51" href="#51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String HOST_KEY = SecureRemoteInvocationFactory.<strong class="jxr_keyword">class</strong>.getName() + <span class="jxr_string">".HOST_KEY"</span>; |
| <a name="52" href="#52">52</a> |
| <a name="53" href="#53">53</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String SESSION_ID_SYSTEM_PROPERTY_NAME = <span class="jxr_string">"shiro.session.id"</span>; |
| <a name="54" href="#54">54</a> |
| <a name="55" href="#55">55</a> <strong class="jxr_keyword">private</strong> String sessionId; |
| <a name="56" href="#56">56</a> |
| <a name="57" href="#57">57</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/spring/remoting/SecureRemoteInvocationFactory.html">SecureRemoteInvocationFactory</a>() { |
| <a name="58" href="#58">58</a> } |
| <a name="59" href="#59">59</a> |
| <a name="60" href="#60">60</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../org/apache/shiro/spring/remoting/SecureRemoteInvocationFactory.html">SecureRemoteInvocationFactory</a>(String sessionId) { |
| <a name="61" href="#61">61</a> <strong class="jxr_keyword">this</strong>(); |
| <a name="62" href="#62">62</a> <strong class="jxr_keyword">this</strong>.sessionId = sessionId; |
| <a name="63" href="#63">63</a> } |
| <a name="64" href="#64">64</a> |
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment">/**</em> |
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * Creates a {@link RemoteInvocation} with the current session ID as an</em> |
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * {@link RemoteInvocation#getAttribute(String) attribute}.</em> |
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> *</em> |
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * @param mi the method invocation that the remote invocation should be based on.</em> |
| <a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> * @return a remote invocation object containing the current session ID as an attribute.</em> |
| <a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> */</em> |
| <a name="72" href="#72">72</a> <strong class="jxr_keyword">public</strong> RemoteInvocation createRemoteInvocation(MethodInvocation mi) { |
| <a name="73" href="#73">73</a> |
| <a name="74" href="#74">74</a> Serializable sessionId = <strong class="jxr_keyword">null</strong>; |
| <a name="75" href="#75">75</a> String host = <strong class="jxr_keyword">null</strong>; |
| <a name="76" href="#76">76</a> <strong class="jxr_keyword">boolean</strong> sessionManagerMethodInvocation = false; |
| <a name="77" href="#77">77</a> |
| <a name="78" href="#78">78</a> <em class="jxr_comment">//If the calling MI is for a remoting SessionManager delegate, we need to acquire the session ID from the method</em> |
| <a name="79" href="#79">79</a> <em class="jxr_comment">//argument and NOT interact with SecurityUtils/subject.getSession to avoid a stack overflow</em> |
| <a name="80" href="#80">80</a> Class miDeclaringClass = mi.getMethod().getDeclaringClass(); |
| <a name="81" href="#81">81</a> <strong class="jxr_keyword">if</strong> (SessionManager.<strong class="jxr_keyword">class</strong>.equals(miDeclaringClass) || NativeSessionManager.<strong class="jxr_keyword">class</strong>.equals(miDeclaringClass)) { |
| <a name="82" href="#82">82</a> sessionManagerMethodInvocation = <strong class="jxr_keyword">true</strong>; |
| <a name="83" href="#83">83</a> <em class="jxr_comment">//for SessionManager calls, all method calls except the 'start' methods require a SessionKey</em> |
| <a name="84" href="#84">84</a> <em class="jxr_comment">// as the first argument, so just get it from there:</em> |
| <a name="85" href="#85">85</a> <strong class="jxr_keyword">if</strong> (!mi.getMethod().getName().equals(<span class="jxr_string">"start"</span>)) { |
| <a name="86" href="#86">86</a> <a href="../../../../../org/apache/shiro/session/mgt/SessionKey.html">SessionKey</a> key = (SessionKey) mi.getArguments()[0]; |
| <a name="87" href="#87">87</a> sessionId = key.getSessionId(); |
| <a name="88" href="#88">88</a> } |
| <a name="89" href="#89">89</a> } |
| <a name="90" href="#90">90</a> |
| <a name="91" href="#91">91</a> <em class="jxr_comment">//tried the delegate. Use the injected session id if given</em> |
| <a name="92" href="#92">92</a> <strong class="jxr_keyword">if</strong> (sessionId == <strong class="jxr_keyword">null</strong>) sessionId = <strong class="jxr_keyword">this</strong>.sessionId; |
| <a name="93" href="#93">93</a> |
| <a name="94" href="#94">94</a> <em class="jxr_comment">// If sessionId is null, only then try the Subject:</em> |
| <a name="95" href="#95">95</a> <strong class="jxr_keyword">if</strong> (sessionId == <strong class="jxr_keyword">null</strong>) { |
| <a name="96" href="#96">96</a> <strong class="jxr_keyword">try</strong> { |
| <a name="97" href="#97">97</a> <em class="jxr_comment">// HACK Check if can get the securityManager - this'll cause an exception if it's not set </em> |
| <a name="98" href="#98">98</a> SecurityUtils.getSecurityManager(); |
| <a name="99" href="#99">99</a> <strong class="jxr_keyword">if</strong> (!sessionManagerMethodInvocation) { |
| <a name="100" href="#100">100</a> <a href="../../../../../org/apache/shiro/subject/Subject.html">Subject</a> subject = SecurityUtils.getSubject(); |
| <a name="101" href="#101">101</a> <a href="../../../../../org/apache/shiro/session/Session.html">Session</a> session = subject.getSession(false); |
| <a name="102" href="#102">102</a> <strong class="jxr_keyword">if</strong> (session != <strong class="jxr_keyword">null</strong>) { |
| <a name="103" href="#103">103</a> sessionId = session.getId(); |
| <a name="104" href="#104">104</a> host = session.getHost(); |
| <a name="105" href="#105">105</a> } |
| <a name="106" href="#106">106</a> } |
| <a name="107" href="#107">107</a> } |
| <a name="108" href="#108">108</a> <strong class="jxr_keyword">catch</strong> (Exception e) { |
| <a name="109" href="#109">109</a> log.trace(<span class="jxr_string">"No security manager set. Trying next to get session id from system property"</span>); |
| <a name="110" href="#110">110</a> } |
| <a name="111" href="#111">111</a> } |
| <a name="112" href="#112">112</a> <em class="jxr_comment">//No call to the sessionManager, and the Subject doesn't have a session. Try a system property</em> |
| <a name="113" href="#113">113</a> <em class="jxr_comment">//as a last result:</em> |
| <a name="114" href="#114">114</a> <strong class="jxr_keyword">if</strong> (sessionId == <strong class="jxr_keyword">null</strong>) { |
| <a name="115" href="#115">115</a> <strong class="jxr_keyword">if</strong> (log.isTraceEnabled()) { |
| <a name="116" href="#116">116</a> log.trace(<span class="jxr_string">"No Session found for the currently executing subject via subject.getSession(false). "</span> + |
| <a name="117" href="#117">117</a> <span class="jxr_string">"Attempting to revert back to the 'shiro.session.id' system property..."</span>); |
| <a name="118" href="#118">118</a> } |
| <a name="119" href="#119">119</a> sessionId = System.getProperty(SESSION_ID_SYSTEM_PROPERTY_NAME); |
| <a name="120" href="#120">120</a> <strong class="jxr_keyword">if</strong> (sessionId == <strong class="jxr_keyword">null</strong> && log.isTraceEnabled()) { |
| <a name="121" href="#121">121</a> log.trace(<span class="jxr_string">"No 'shiro.session.id' system property found. Heuristics have been exhausted; "</span> + |
| <a name="122" href="#122">122</a> <span class="jxr_string">"RemoteInvocation will not contain a sessionId."</span>); |
| <a name="123" href="#123">123</a> } |
| <a name="124" href="#124">124</a> } |
| <a name="125" href="#125">125</a> |
| <a name="126" href="#126">126</a> RemoteInvocation ri = <strong class="jxr_keyword">new</strong> RemoteInvocation(mi); |
| <a name="127" href="#127">127</a> <strong class="jxr_keyword">if</strong> (sessionId != <strong class="jxr_keyword">null</strong>) { |
| <a name="128" href="#128">128</a> ri.addAttribute(SESSION_ID_KEY, sessionId); |
| <a name="129" href="#129">129</a> } |
| <a name="130" href="#130">130</a> <strong class="jxr_keyword">if</strong> (host != <strong class="jxr_keyword">null</strong>) { |
| <a name="131" href="#131">131</a> ri.addAttribute(HOST_KEY, host); |
| <a name="132" href="#132">132</a> } |
| <a name="133" href="#133">133</a> |
| <a name="134" href="#134">134</a> <strong class="jxr_keyword">return</strong> ri; |
| <a name="135" href="#135">135</a> } |
| <a name="136" href="#136">136</a> } |
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
