blob: b6d291bd1dd579520db5d1c2ccd14cbecef3ae24 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.shiro.spring.remoting;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.shiro.SecurityUtils;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.shiro.mgt.SecurityManager;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.shiro.subject.ExecutionException;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.shiro.subject.Subject;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.slf4j.Logger;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.slf4j.LoggerFactory;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.springframework.remoting.support.DefaultRemoteInvocationExecutor;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.springframework.remoting.support.RemoteInvocation;<a name="line.28"></a>
<span class="sourceLineNo">029</span><a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.io.Serializable;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.lang.reflect.InvocationTargetException;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.util.concurrent.Callable;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span>/**<a name="line.35"></a>
<span class="sourceLineNo">036</span> * An implementation of the Spring {@link org.springframework.remoting.support.RemoteInvocationExecutor}<a name="line.36"></a>
<span class="sourceLineNo">037</span> * that binds a {@code sessionId} to the incoming thread to make it available to the {@code SecurityManager}<a name="line.37"></a>
<span class="sourceLineNo">038</span> * implementation during the thread execution. The {@code SecurityManager} implementation can use this sessionId<a name="line.38"></a>
<span class="sourceLineNo">039</span> * to reconstitute the {@code Subject} instance based on persistent state in the corresponding {@code Session}.<a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> * @since 0.1<a name="line.41"></a>
<span class="sourceLineNo">042</span> */<a name="line.42"></a>
<span class="sourceLineNo">043</span>public class SecureRemoteInvocationExecutor extends DefaultRemoteInvocationExecutor {<a name="line.43"></a>
<span class="sourceLineNo">044</span><a name="line.44"></a>
<span class="sourceLineNo">045</span> //TODO - complete JavaDoc<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /*--------------------------------------------<a name="line.47"></a>
<span class="sourceLineNo">048</span> | C O N S T A N T S |<a name="line.48"></a>
<span class="sourceLineNo">049</span> ============================================*/<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> /*--------------------------------------------<a name="line.51"></a>
<span class="sourceLineNo">052</span> | I N S T A N C E V A R I A B L E S |<a name="line.52"></a>
<span class="sourceLineNo">053</span> ============================================*/<a name="line.53"></a>
<span class="sourceLineNo">054</span> private static final Logger log = LoggerFactory.getLogger(SecureRemoteInvocationExecutor.class);<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> /**<a name="line.56"></a>
<span class="sourceLineNo">057</span> * The SecurityManager used to retrieve realms that should be associated with the<a name="line.57"></a>
<span class="sourceLineNo">058</span> * created &lt;tt&gt;Subject&lt;/tt&gt;s upon remote invocation.<a name="line.58"></a>
<span class="sourceLineNo">059</span> */<a name="line.59"></a>
<span class="sourceLineNo">060</span> private SecurityManager securityManager;<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> /*--------------------------------------------<a name="line.62"></a>
<span class="sourceLineNo">063</span> | C O N S T R U C T O R S |<a name="line.63"></a>
<span class="sourceLineNo">064</span> ============================================*/<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span> /*--------------------------------------------<a name="line.66"></a>
<span class="sourceLineNo">067</span> | A C C E S S O R S / M O D I F I E R S |<a name="line.67"></a>
<span class="sourceLineNo">068</span> ============================================*/<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span> public void setSecurityManager(org.apache.shiro.mgt.SecurityManager securityManager) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> this.securityManager = securityManager;<a name="line.71"></a>
<span class="sourceLineNo">072</span> }<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> /*--------------------------------------------<a name="line.74"></a>
<span class="sourceLineNo">075</span> | M E T H O D S |<a name="line.75"></a>
<span class="sourceLineNo">076</span> ============================================*/<a name="line.76"></a>
<span class="sourceLineNo">077</span> @SuppressWarnings({"unchecked"})<a name="line.77"></a>
<span class="sourceLineNo">078</span> public Object invoke(final RemoteInvocation invocation, final Object targetObject)<a name="line.78"></a>
<span class="sourceLineNo">079</span> throws NoSuchMethodException, IllegalAccessException, InvocationTargetException {<a name="line.79"></a>
<span class="sourceLineNo">080</span><a name="line.80"></a>
<span class="sourceLineNo">081</span> try {<a name="line.81"></a>
<span class="sourceLineNo">082</span> SecurityManager securityManager =<a name="line.82"></a>
<span class="sourceLineNo">083</span> this.securityManager != null ? this.securityManager : SecurityUtils.getSecurityManager();<a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> Subject.Builder builder = new Subject.Builder(securityManager);<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span> String host = (String) invocation.getAttribute(SecureRemoteInvocationFactory.HOST_KEY);<a name="line.87"></a>
<span class="sourceLineNo">088</span> if (host != null) {<a name="line.88"></a>
<span class="sourceLineNo">089</span> builder.host(host);<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> Serializable sessionId = invocation.getAttribute(SecureRemoteInvocationFactory.SESSION_ID_KEY);<a name="line.92"></a>
<span class="sourceLineNo">093</span> if (sessionId != null) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> builder.sessionId(sessionId);<a name="line.94"></a>
<span class="sourceLineNo">095</span> } else {<a name="line.95"></a>
<span class="sourceLineNo">096</span> if (log.isTraceEnabled()) {<a name="line.96"></a>
<span class="sourceLineNo">097</span> log.trace("RemoteInvocation did not contain a Shiro Session id attribute under " +<a name="line.97"></a>
<span class="sourceLineNo">098</span> "key [" + SecureRemoteInvocationFactory.SESSION_ID_KEY + "]. A Subject based " +<a name="line.98"></a>
<span class="sourceLineNo">099</span> "on an existing Session will not be available during the method invocatin.");<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span> }<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span> Subject subject = builder.buildSubject();<a name="line.103"></a>
<span class="sourceLineNo">104</span> return subject.execute(new Callable() {<a name="line.104"></a>
<span class="sourceLineNo">105</span> public Object call() throws Exception {<a name="line.105"></a>
<span class="sourceLineNo">106</span> return SecureRemoteInvocationExecutor.super.invoke(invocation, targetObject);<a name="line.106"></a>
<span class="sourceLineNo">107</span> }<a name="line.107"></a>
<span class="sourceLineNo">108</span> });<a name="line.108"></a>
<span class="sourceLineNo">109</span> } catch (ExecutionException e) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> Throwable cause = e.getCause();<a name="line.110"></a>
<span class="sourceLineNo">111</span> if (cause instanceof NoSuchMethodException) {<a name="line.111"></a>
<span class="sourceLineNo">112</span> throw (NoSuchMethodException) cause;<a name="line.112"></a>
<span class="sourceLineNo">113</span> } else if (cause instanceof IllegalAccessException) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> throw (IllegalAccessException) cause;<a name="line.114"></a>
<span class="sourceLineNo">115</span> } else if (cause instanceof InvocationTargetException) {<a name="line.115"></a>
<span class="sourceLineNo">116</span> throw (InvocationTargetException) cause;<a name="line.116"></a>
<span class="sourceLineNo">117</span> } else {<a name="line.117"></a>
<span class="sourceLineNo">118</span> throw new InvocationTargetException(cause);<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span> } catch (Throwable t) {<a name="line.120"></a>
<span class="sourceLineNo">121</span> throw new InvocationTargetException(t);<a name="line.121"></a>
<span class="sourceLineNo">122</span> }<a name="line.122"></a>
<span class="sourceLineNo">123</span> }<a name="line.123"></a>
<span class="sourceLineNo">124</span>}<a name="line.124"></a>
</pre>
</div>
</body>
</html>