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