blob: a6c94cefb344d7e996553ce0514bcb4630b3b7c1 [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.filter.mgt;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.util.ClassUtils;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.web.filter.authc.*;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.web.filter.authz.*;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.web.filter.session.NoSessionCreationFilter;</a>
<span class="sourceLineNo">025</span><a id="line.25"></a>
<span class="sourceLineNo">026</span><a id="line.26">import javax.servlet.Filter;</a>
<span class="sourceLineNo">027</span><a id="line.27">import javax.servlet.FilterConfig;</a>
<span class="sourceLineNo">028</span><a id="line.28">import javax.servlet.ServletException;</a>
<span class="sourceLineNo">029</span><a id="line.29">import java.util.LinkedHashMap;</a>
<span class="sourceLineNo">030</span><a id="line.30">import java.util.Map;</a>
<span class="sourceLineNo">031</span><a id="line.31"></a>
<span class="sourceLineNo">032</span><a id="line.32">/**</a>
<span class="sourceLineNo">033</span><a id="line.33"> * Enum representing all of the default Shiro Filter instances available to web applications. Each filter instance is</a>
<span class="sourceLineNo">034</span><a id="line.34"> * typically accessible in configuration the {@link #name() name} of the enum constant.</a>
<span class="sourceLineNo">035</span><a id="line.35"> *</a>
<span class="sourceLineNo">036</span><a id="line.36"> * @since 1.0</a>
<span class="sourceLineNo">037</span><a id="line.37"> */</a>
<span class="sourceLineNo">038</span><a id="line.38">public enum DefaultFilter {</a>
<span class="sourceLineNo">039</span><a id="line.39"></a>
<span class="sourceLineNo">040</span><a id="line.40"> anon(AnonymousFilter.class),</a>
<span class="sourceLineNo">041</span><a id="line.41"> authc(FormAuthenticationFilter.class),</a>
<span class="sourceLineNo">042</span><a id="line.42"> authcBasic(BasicHttpAuthenticationFilter.class),</a>
<span class="sourceLineNo">043</span><a id="line.43"> authcBearer(BearerHttpAuthenticationFilter.class),</a>
<span class="sourceLineNo">044</span><a id="line.44"> logout(LogoutFilter.class),</a>
<span class="sourceLineNo">045</span><a id="line.45"> noSessionCreation(NoSessionCreationFilter.class),</a>
<span class="sourceLineNo">046</span><a id="line.46"> perms(PermissionsAuthorizationFilter.class),</a>
<span class="sourceLineNo">047</span><a id="line.47"> port(PortFilter.class),</a>
<span class="sourceLineNo">048</span><a id="line.48"> rest(HttpMethodPermissionFilter.class),</a>
<span class="sourceLineNo">049</span><a id="line.49"> roles(RolesAuthorizationFilter.class),</a>
<span class="sourceLineNo">050</span><a id="line.50"> ssl(SslFilter.class),</a>
<span class="sourceLineNo">051</span><a id="line.51"> user(UserFilter.class);</a>
<span class="sourceLineNo">052</span><a id="line.52"></a>
<span class="sourceLineNo">053</span><a id="line.53"> private final Class&lt;? extends Filter&gt; filterClass;</a>
<span class="sourceLineNo">054</span><a id="line.54"></a>
<span class="sourceLineNo">055</span><a id="line.55"> private DefaultFilter(Class&lt;? extends Filter&gt; filterClass) {</a>
<span class="sourceLineNo">056</span><a id="line.56"> this.filterClass = filterClass;</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"> public Filter newInstance() {</a>
<span class="sourceLineNo">060</span><a id="line.60"> return (Filter) ClassUtils.newInstance(this.filterClass);</a>
<span class="sourceLineNo">061</span><a id="line.61"> }</a>
<span class="sourceLineNo">062</span><a id="line.62"></a>
<span class="sourceLineNo">063</span><a id="line.63"> public Class&lt;? extends Filter&gt; getFilterClass() {</a>
<span class="sourceLineNo">064</span><a id="line.64"> return this.filterClass;</a>
<span class="sourceLineNo">065</span><a id="line.65"> }</a>
<span class="sourceLineNo">066</span><a id="line.66"></a>
<span class="sourceLineNo">067</span><a id="line.67"> public static Map&lt;String, Filter&gt; createInstanceMap(FilterConfig config) {</a>
<span class="sourceLineNo">068</span><a id="line.68"> Map&lt;String, Filter&gt; filters = new LinkedHashMap&lt;String, Filter&gt;(values().length);</a>
<span class="sourceLineNo">069</span><a id="line.69"> for (DefaultFilter defaultFilter : values()) {</a>
<span class="sourceLineNo">070</span><a id="line.70"> Filter filter = defaultFilter.newInstance();</a>
<span class="sourceLineNo">071</span><a id="line.71"> if (config != null) {</a>
<span class="sourceLineNo">072</span><a id="line.72"> try {</a>
<span class="sourceLineNo">073</span><a id="line.73"> filter.init(config);</a>
<span class="sourceLineNo">074</span><a id="line.74"> } catch (ServletException e) {</a>
<span class="sourceLineNo">075</span><a id="line.75"> String msg = "Unable to correctly init default filter instance of type " +</a>
<span class="sourceLineNo">076</span><a id="line.76"> filter.getClass().getName();</a>
<span class="sourceLineNo">077</span><a id="line.77"> throw new IllegalStateException(msg, e);</a>
<span class="sourceLineNo">078</span><a id="line.78"> }</a>
<span class="sourceLineNo">079</span><a id="line.79"> }</a>
<span class="sourceLineNo">080</span><a id="line.80"> filters.put(defaultFilter.name(), filter);</a>
<span class="sourceLineNo">081</span><a id="line.81"> }</a>
<span class="sourceLineNo">082</span><a id="line.82"> return filters;</a>
<span class="sourceLineNo">083</span><a id="line.83"> }</a>
<span class="sourceLineNo">084</span><a id="line.84">}</a>
</pre>
</div>
</main>
</body>
</html>