blob: 15e13db997cc40ed5e5289e1cbb32ddea185138e [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<main role="main">
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a id="line.1">/*</a>
<span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a>
<span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a>
<span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a>
<span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a>
<span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a>
<span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a>
<span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a>
<span class="sourceLineNo">009</span><a id="line.9"> *</a>
<span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a>
<span class="sourceLineNo">011</span><a id="line.11"> *</a>
<span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a>
<span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a>
<span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a>
<span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a>
<span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a>
<span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a>
<span class="sourceLineNo">018</span><a id="line.18"> */</a>
<span class="sourceLineNo">019</span><a id="line.19">package org.apache.shiro.guice;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import com.google.inject.Key;</a>
<span class="sourceLineNo">022</span><a id="line.22">import com.google.inject.OutOfScopeException;</a>
<span class="sourceLineNo">023</span><a id="line.23">import com.google.inject.Provider;</a>
<span class="sourceLineNo">024</span><a id="line.24">import com.google.inject.Scope;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.shiro.session.Session;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.shiro.subject.Subject;</a>
<span class="sourceLineNo">027</span><a id="line.27">import org.apache.shiro.util.ThreadContext;</a>
<span class="sourceLineNo">028</span><a id="line.28"></a>
<span class="sourceLineNo">029</span><a id="line.29">/**</a>
<span class="sourceLineNo">030</span><a id="line.30"> * Guice scope for Shiro sessions. Not bound by default.</a>
<span class="sourceLineNo">031</span><a id="line.31"> */</a>
<span class="sourceLineNo">032</span><a id="line.32">public class ShiroSessionScope implements Scope {</a>
<span class="sourceLineNo">033</span><a id="line.33"> public &lt;T&gt; Provider&lt;T&gt; scope(final Key&lt;T&gt; key, final Provider&lt;T&gt; unscoped) {</a>
<span class="sourceLineNo">034</span><a id="line.34"> return new Provider&lt;T&gt;() {</a>
<span class="sourceLineNo">035</span><a id="line.35"> public T get() {</a>
<span class="sourceLineNo">036</span><a id="line.36"> Subject subject = ThreadContext.getSubject();</a>
<span class="sourceLineNo">037</span><a id="line.37"> if (subject == null) {</a>
<span class="sourceLineNo">038</span><a id="line.38"> throw new OutOfScopeException("There is no Shiro Session currently in scope.");</a>
<span class="sourceLineNo">039</span><a id="line.39"> }</a>
<span class="sourceLineNo">040</span><a id="line.40"> Session session = subject.getSession();</a>
<span class="sourceLineNo">041</span><a id="line.41"> T scoped = castSessionAttribute(session);</a>
<span class="sourceLineNo">042</span><a id="line.42"> if (scoped == null) {</a>
<span class="sourceLineNo">043</span><a id="line.43"> scoped = unscoped.get();</a>
<span class="sourceLineNo">044</span><a id="line.44"> }</a>
<span class="sourceLineNo">045</span><a id="line.45"> return scoped;</a>
<span class="sourceLineNo">046</span><a id="line.46"> }</a>
<span class="sourceLineNo">047</span><a id="line.47"></a>
<span class="sourceLineNo">048</span><a id="line.48"> @SuppressWarnings({"unchecked"})</a>
<span class="sourceLineNo">049</span><a id="line.49"> private T castSessionAttribute(Session session) {</a>
<span class="sourceLineNo">050</span><a id="line.50"> return (T) session.getAttribute(key);</a>
<span class="sourceLineNo">051</span><a id="line.51"> }</a>
<span class="sourceLineNo">052</span><a id="line.52"></a>
<span class="sourceLineNo">053</span><a id="line.53"> @Override</a>
<span class="sourceLineNo">054</span><a id="line.54"> public String toString() {</a>
<span class="sourceLineNo">055</span><a id="line.55"> return unscoped.toString();</a>
<span class="sourceLineNo">056</span><a id="line.56"> }</a>
<span class="sourceLineNo">057</span><a id="line.57"> };</a>
<span class="sourceLineNo">058</span><a id="line.58"> }</a>
<span class="sourceLineNo">059</span><a id="line.59"></a>
<span class="sourceLineNo">060</span><a id="line.60"> @Override</a>
<span class="sourceLineNo">061</span><a id="line.61"> public String toString() {</a>
<span class="sourceLineNo">062</span><a id="line.62"> return "ShiroSessionScope";</a>
<span class="sourceLineNo">063</span><a id="line.63"> }</a>
<span class="sourceLineNo">064</span><a id="line.64">}</a>
</pre>
</div>
</main>
</body>
</html>