| <!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.servlet;</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.Nameable;</a> |
| <span class="sourceLineNo">022</span><a id="line.22"></a> |
| <span class="sourceLineNo">023</span><a id="line.23">import javax.servlet.FilterConfig;</a> |
| <span class="sourceLineNo">024</span><a id="line.24"></a> |
| <span class="sourceLineNo">025</span><a id="line.25">/**</a> |
| <span class="sourceLineNo">026</span><a id="line.26"> * Allows a filter to be named via JavaBeans-compatible</a> |
| <span class="sourceLineNo">027</span><a id="line.27"> * {@link #getName()}/{@link #setName(String)} methods. If no name is specified, the name of the filter will</a> |
| <span class="sourceLineNo">028</span><a id="line.28"> * default to the name given to it in {@code web.xml} (the {@code FilterConfig}'s</a> |
| <span class="sourceLineNo">029</span><a id="line.29"> * {@link javax.servlet.FilterConfig#getFilterName() filterName}).</a> |
| <span class="sourceLineNo">030</span><a id="line.30"> *</a> |
| <span class="sourceLineNo">031</span><a id="line.31"> * @since 1.0</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> */</a> |
| <span class="sourceLineNo">033</span><a id="line.33">public abstract class NameableFilter extends AbstractFilter implements Nameable {</a> |
| <span class="sourceLineNo">034</span><a id="line.34"></a> |
| <span class="sourceLineNo">035</span><a id="line.35"> /**</a> |
| <span class="sourceLineNo">036</span><a id="line.36"> * The name of this filter, unique within an application.</a> |
| <span class="sourceLineNo">037</span><a id="line.37"> */</a> |
| <span class="sourceLineNo">038</span><a id="line.38"> private String name;</a> |
| <span class="sourceLineNo">039</span><a id="line.39"></a> |
| <span class="sourceLineNo">040</span><a id="line.40"> /**</a> |
| <span class="sourceLineNo">041</span><a id="line.41"> * Returns the filter's name.</a> |
| <span class="sourceLineNo">042</span><a id="line.42"> * <p/></a> |
| <span class="sourceLineNo">043</span><a id="line.43"> * Unless overridden by calling the {@link #setName(String) setName(String)} method, this value defaults to the</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> * filter name as specified by the servlet container at start-up:</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> * <pre></a> |
| <span class="sourceLineNo">046</span><a id="line.46"> * this.name = {@link #getFilterConfig() getFilterConfig()}.{@link javax.servlet.FilterConfig#getFilterName() getName()};</pre></a> |
| <span class="sourceLineNo">047</span><a id="line.47"> *</a> |
| <span class="sourceLineNo">048</span><a id="line.48"> * @return the filter name, or {@code null} if none available</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> * @see javax.servlet.GenericServlet#getServletName()</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> * @see javax.servlet.FilterConfig#getFilterName()</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> */</a> |
| <span class="sourceLineNo">052</span><a id="line.52"> protected String getName() {</a> |
| <span class="sourceLineNo">053</span><a id="line.53"> if (this.name == null) {</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> FilterConfig config = getFilterConfig();</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> if (config != null) {</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> this.name = config.getFilterName();</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"></a> |
| <span class="sourceLineNo">060</span><a id="line.60"> return this.name;</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"> /**</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> * Sets the filter's name.</a> |
| <span class="sourceLineNo">065</span><a id="line.65"> * <p/></a> |
| <span class="sourceLineNo">066</span><a id="line.66"> * Unless overridden by calling this method, this value defaults to the filter name as specified by the</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> * servlet container at start-up:</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> * <pre></a> |
| <span class="sourceLineNo">069</span><a id="line.69"> * this.name = {@link #getFilterConfig() getFilterConfig()}.{@link javax.servlet.FilterConfig#getFilterName() getName()};</pre></a> |
| <span class="sourceLineNo">070</span><a id="line.70"> *</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> * @param name the name of the filter.</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> */</a> |
| <span class="sourceLineNo">073</span><a id="line.73"> public void setName(String name) {</a> |
| <span class="sourceLineNo">074</span><a id="line.74"> this.name = name;</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> }</a> |
| <span class="sourceLineNo">076</span><a id="line.76"></a> |
| <span class="sourceLineNo">077</span><a id="line.77"> /**</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> * Returns a StringBuilder instance with the {@link #getName() name}, or if the name is {@code null}, just the</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> * {@code super.toStringBuilder()} instance.</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> *</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> * @return a StringBuilder instance to use for appending String data that will eventually be returned from a</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> * {@code toString()} invocation.</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> */</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> protected StringBuilder toStringBuilder() {</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> String name = getName();</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> if (name == null) {</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> return super.toStringBuilder();</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> } else {</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> StringBuilder sb = new StringBuilder();</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> sb.append(name);</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> return sb;</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> }</a> |
| <span class="sourceLineNo">093</span><a id="line.93"> }</a> |
| <span class="sourceLineNo">094</span><a id="line.94"></a> |
| <span class="sourceLineNo">095</span><a id="line.95">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
