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