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