blob: 6514c78c1832a2453d3fdc8a300cf7c7f6806b0b [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.web.config;</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"></a>
<span class="sourceLineNo">023</span><a id="line.23">/**</a>
<span class="sourceLineNo">024</span><a id="line.24"> * Configuration for Shiro's root level servlet filter.</a>
<span class="sourceLineNo">025</span><a id="line.25"> *</a>
<span class="sourceLineNo">026</span><a id="line.26"> * @since 1.10.0</a>
<span class="sourceLineNo">027</span><a id="line.27"> */</a>
<span class="sourceLineNo">028</span><a id="line.28">public class ShiroFilterConfiguration {</a>
<span class="sourceLineNo">029</span><a id="line.29"></a>
<span class="sourceLineNo">030</span><a id="line.30"> private boolean filterOncePerRequest = false;</a>
<span class="sourceLineNo">031</span><a id="line.31"></a>
<span class="sourceLineNo">032</span><a id="line.32"> private boolean staticSecurityManagerEnabled = false;</a>
<span class="sourceLineNo">033</span><a id="line.33"></a>
<span class="sourceLineNo">034</span><a id="line.34"> /**</a>
<span class="sourceLineNo">035</span><a id="line.35"> * Returns {@code true} if the filter should only execute once per request. If set to {@code false} the filter</a>
<span class="sourceLineNo">036</span><a id="line.36"> * will execute each time it is invoked.</a>
<span class="sourceLineNo">037</span><a id="line.37"> * @return {@code true} if this filter should only execute once per request.</a>
<span class="sourceLineNo">038</span><a id="line.38"> */</a>
<span class="sourceLineNo">039</span><a id="line.39"> public boolean isFilterOncePerRequest() {</a>
<span class="sourceLineNo">040</span><a id="line.40"> return filterOncePerRequest;</a>
<span class="sourceLineNo">041</span><a id="line.41"> }</a>
<span class="sourceLineNo">042</span><a id="line.42"></a>
<span class="sourceLineNo">043</span><a id="line.43"> /**</a>
<span class="sourceLineNo">044</span><a id="line.44"> * Sets whether the filter executes once per request or for every invocation of the filter. It is recommended</a>
<span class="sourceLineNo">045</span><a id="line.45"> * to leave this disabled if you are using a {@link javax.servlet.RequestDispatcher RequestDispatcher} to forward</a>
<span class="sourceLineNo">046</span><a id="line.46"> * or include request (JSP tags, programmatically, or via a framework).</a>
<span class="sourceLineNo">047</span><a id="line.47"> *</a>
<span class="sourceLineNo">048</span><a id="line.48"> * @param filterOncePerRequest Whether this filter executes once per request.</a>
<span class="sourceLineNo">049</span><a id="line.49"> */</a>
<span class="sourceLineNo">050</span><a id="line.50"> public void setFilterOncePerRequest(boolean filterOncePerRequest) {</a>
<span class="sourceLineNo">051</span><a id="line.51"> this.filterOncePerRequest = filterOncePerRequest;</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>
<span class="sourceLineNo">055</span><a id="line.55"> * Returns {@code true} if the constructed {@link SecurityManager SecurityManager} associated with the filter</a>
<span class="sourceLineNo">056</span><a id="line.56"> * should be bound to static memory (via</a>
<span class="sourceLineNo">057</span><a id="line.57"> * {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}),</a>
<span class="sourceLineNo">058</span><a id="line.58"> * {@code false} otherwise.</a>
<span class="sourceLineNo">059</span><a id="line.59"> * &lt;p/&gt;</a>
<span class="sourceLineNo">060</span><a id="line.60"> * The default value is {@code false}.</a>
<span class="sourceLineNo">061</span><a id="line.61"> * &lt;p/&gt;</a>
<span class="sourceLineNo">062</span><a id="line.62"> *</a>
<span class="sourceLineNo">063</span><a id="line.63"> * @return {@code true} if the constructed {@link SecurityManager SecurityManager} associated with the filter should be bound</a>
<span class="sourceLineNo">064</span><a id="line.64"> * to static memory (via {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}),</a>
<span class="sourceLineNo">065</span><a id="line.65"> * {@code false} otherwise.</a>
<span class="sourceLineNo">066</span><a id="line.66"> * @see &lt;a href="https://issues.apache.org/jira/browse/SHIRO-287"&gt;SHIRO-287&lt;/a&gt;</a>
<span class="sourceLineNo">067</span><a id="line.67"> */</a>
<span class="sourceLineNo">068</span><a id="line.68"> public boolean isStaticSecurityManagerEnabled() {</a>
<span class="sourceLineNo">069</span><a id="line.69"> return staticSecurityManagerEnabled;</a>
<span class="sourceLineNo">070</span><a id="line.70"> }</a>
<span class="sourceLineNo">071</span><a id="line.71"></a>
<span class="sourceLineNo">072</span><a id="line.72"> /**</a>
<span class="sourceLineNo">073</span><a id="line.73"> * Sets if the constructed {@link SecurityManager SecurityManager} associated with the filter should be bound</a>
<span class="sourceLineNo">074</span><a id="line.74"> * to static memory (via {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}).</a>
<span class="sourceLineNo">075</span><a id="line.75"> * &lt;p/&gt;</a>
<span class="sourceLineNo">076</span><a id="line.76"> * The default value is {@code false}.</a>
<span class="sourceLineNo">077</span><a id="line.77"> *</a>
<span class="sourceLineNo">078</span><a id="line.78"> * @param staticSecurityManagerEnabled if the constructed {@link SecurityManager SecurityManager} associated with the filter</a>
<span class="sourceLineNo">079</span><a id="line.79"> * should be bound to static memory (via</a>
<span class="sourceLineNo">080</span><a id="line.80"> * {@code SecurityUtils.}{@link SecurityUtils#setSecurityManager(org.apache.shiro.mgt.SecurityManager) setSecurityManager}).</a>
<span class="sourceLineNo">081</span><a id="line.81"> * @see &lt;a href="https://issues.apache.org/jira/browse/SHIRO-287"&gt;SHIRO-287&lt;/a&gt;</a>
<span class="sourceLineNo">082</span><a id="line.82"> */</a>
<span class="sourceLineNo">083</span><a id="line.83"> public ShiroFilterConfiguration setStaticSecurityManagerEnabled(boolean staticSecurityManagerEnabled) {</a>
<span class="sourceLineNo">084</span><a id="line.84"> this.staticSecurityManagerEnabled = staticSecurityManagerEnabled;</a>
<span class="sourceLineNo">085</span><a id="line.85"> return this;</a>
<span class="sourceLineNo">086</span><a id="line.86"> }</a>
<span class="sourceLineNo">087</span><a id="line.87">}</a>
</pre>
</div>
</main>
</body>
</html>