| <!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.web.subject;<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.Subject;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.shiro.subject.SubjectContext;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.shiro.web.subject.support.DefaultWebSubjectContext;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import org.apache.shiro.web.util.RequestPairSource;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span><a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import javax.servlet.ServletRequest;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import javax.servlet.ServletResponse;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span><a name="line.30"></a> |
| <span class="sourceLineNo">031</span>/**<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * A {@code WebSubject} represents a Subject instance that was acquired as a result of an incoming<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * {@link ServletRequest}.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> *<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * @since 1.0<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> */<a name="line.36"></a> |
| <span class="sourceLineNo">037</span>public interface WebSubject extends Subject, RequestPairSource {<a name="line.37"></a> |
| <span class="sourceLineNo">038</span><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> /**<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * Returns the {@code ServletRequest} accessible when the Subject instance was created.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> *<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * @return the {@code ServletRequest} accessible when the Subject instance was created.<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> */<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> ServletRequest getServletRequest();<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> /**<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Returns the {@code ServletResponse} accessible when the Subject instance was created.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> *<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @return the {@code ServletResponse} accessible when the Subject instance was created.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> */<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> ServletResponse getServletResponse();<a name="line.51"></a> |
| <span class="sourceLineNo">052</span><a name="line.52"></a> |
| <span class="sourceLineNo">053</span> /**<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * A {@code WebSubject.Builder} performs the same function as a {@link Subject.Builder Subject.Builder}, but<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * additionally ensures that the Servlet request/response pair that is triggering the Subject instance's creation<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * is retained for use by internal Shiro components as necessary.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> */<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> public static class Builder extends Subject.Builder {<a name="line.58"></a> |
| <span class="sourceLineNo">059</span><a name="line.59"></a> |
| <span class="sourceLineNo">060</span> /**<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> * Constructs a new {@code Web.Builder} instance using the {@link SecurityManager SecurityManager} obtained by<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * calling {@code SecurityUtils.}{@link SecurityUtils#getSecurityManager() getSecurityManager()}. If you want<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * to specify your own SecurityManager instance, use the<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * {@link #Builder(SecurityManager, ServletRequest, ServletResponse)} constructor instead.<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> *<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @param request the incoming ServletRequest that will be associated with the built {@code WebSubject} instance.<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> * @param response the outgoing ServletRequest paired with the ServletRequest that will be associated with the<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> * built {@code WebSubject} instance.<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> */<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> public Builder(ServletRequest request, ServletResponse response) {<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> this(SecurityUtils.getSecurityManager(), request, response);<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> * Constructs a new {@code Web.Builder} instance using the specified {@code SecurityManager} instance to<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * create the {@link WebSubject WebSubject} instance.<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> *<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @param securityManager the {@code SecurityManager SecurityManager} instance to use to build the<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * {@code WebSubject} instance.<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * @param request the incoming ServletRequest that will be associated with the built {@code WebSubject}<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * instance.<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @param response the outgoing ServletRequest paired with the ServletRequest that will be associated<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> * with the built {@code WebSubject} instance.<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> */<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> public Builder(SecurityManager securityManager, ServletRequest request, ServletResponse response) {<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> super(securityManager);<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> if (request == null) {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> throw new IllegalArgumentException("ServletRequest argument cannot be null.");<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> }<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> if (response == null) {<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> throw new IllegalArgumentException("ServletResponse argument cannot be null.");<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> }<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> setRequest(request);<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> setResponse(response);<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> }<a name="line.95"></a> |
| <span class="sourceLineNo">096</span><a name="line.96"></a> |
| <span class="sourceLineNo">097</span> /**<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * Overrides the parent implementation to return a new instance of a<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * {@link DefaultWebSubjectContext DefaultWebSubjectContext} to account for the additional request/response<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * pair.<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> *<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> * @return a new instance of a {@link DefaultWebSubjectContext DefaultWebSubjectContext} to account for the<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * additional request/response pair.<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> */<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> @Override<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> protected SubjectContext newSubjectContextInstance() {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> return new DefaultWebSubjectContext();<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> /**<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> * Called by the {@code WebSubject.Builder} constructor, this method places the request object in the<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * context map for later retrieval.<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> *<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * @param request the incoming ServletRequest that triggered the creation of the {@code WebSubject} instance.<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * @return 'this' for method chaining.<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> */<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> protected Builder setRequest(ServletRequest request) {<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> if (request != null) {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> ((WebSubjectContext) getSubjectContext()).setServletRequest(request);<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> }<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> return this;<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> |
| <span class="sourceLineNo">125</span> * Called by the {@code WebSubject.Builder} constructor, this method places the response object in the<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * context map for later retrieval.<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> *<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * @param response the outgoing ServletRequest paired with the ServletRequest that triggered the creation of<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * the {@code WebSubject} instance.<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * @return 'this' for method chaining.<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> */<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> protected Builder setResponse(ServletResponse response) {<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> if (response != null) {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> ((WebSubjectContext) getSubjectContext()).setServletResponse(response);<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> }<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> return this;<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> }<a name="line.137"></a> |
| <span class="sourceLineNo">138</span><a name="line.138"></a> |
| <span class="sourceLineNo">139</span> /**<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> * Returns {@link #buildSubject() super.buildSubject()}, but additionally ensures that the returned instance<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * is an {@code instanceof} {@link WebSubject WebSubject} and to support a type-safe method so a caller<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> * does not have to cast. Per the parent class's method JavaDoc, this method will return a new instance<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * each time it is called.<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> *<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * @return a new {@link WebSubject WebSubject} instance built by this {@code Builder}.<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> */<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> public WebSubject buildWebSubject() {<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> Subject subject = super.buildSubject();<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> if (!(subject instanceof WebSubject)) {<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> String msg = "Subject implementation returned from the SecurityManager was not a " +<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> WebSubject.class.getName() + " implementation. Please ensure a Web-enabled SecurityManager " +<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> "has been configured and made available to this builder.";<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> throw new IllegalStateException(msg);<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> }<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> return (WebSubject) subject;<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> }<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> }<a name="line.157"></a> |
| <span class="sourceLineNo">158</span><a name="line.158"></a> |
| <span class="sourceLineNo">159</span>}<a name="line.159"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
