Google Git
Sign in
apache / shiro-site / 01016f43374d9b054f3ea1e568b015d5d69428f9 / . / src / site / assets / static / 1.2.2 / apidocs / src-html / org / apache / shiro / web / filter / mgt / SimpleNamedFilterList.html
blob: 2ce4a042c3c4e007e50ab39924be7f85b3799495 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a>
<span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<span class="sourceLineNo">009</span> *<a name="line.9"></a>
<span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * software distributed under the License is distributed on an<a name="line.13"></a>
<span class="sourceLineNo">014</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<span class="sourceLineNo">015</span> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<span class="sourceLineNo">016</span> * specific language governing permissions and limitations<a name="line.16"></a>
<span class="sourceLineNo">017</span> * under the License.<a name="line.17"></a>
<span class="sourceLineNo">018</span> */<a name="line.18"></a>
<span class="sourceLineNo">019</span>package org.apache.shiro.web.filter.mgt;<a name="line.19"></a>
<span class="sourceLineNo">020</span><a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.shiro.util.StringUtils;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.shiro.web.servlet.ProxiedFilterChain;<a name="line.22"></a>
<span class="sourceLineNo">023</span><a name="line.23"></a>
<span class="sourceLineNo">024</span>import javax.servlet.Filter;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import javax.servlet.FilterChain;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.*;<a name="line.26"></a>
<span class="sourceLineNo">027</span><a name="line.27"></a>
<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
<span class="sourceLineNo">029</span> * Simple {@code NamedFilterList} implementation that is supported by a backing {@link List} instance and a simple<a name="line.29"></a>
<span class="sourceLineNo">030</span> * {@link #getName() name} property. All {@link List} method implementations are immediately delegated to the<a name="line.30"></a>
<span class="sourceLineNo">031</span> * wrapped backing list.<a name="line.31"></a>
<span class="sourceLineNo">032</span> *<a name="line.32"></a>
<span class="sourceLineNo">033</span> * @since 1.0<a name="line.33"></a>
<span class="sourceLineNo">034</span> */<a name="line.34"></a>
<span class="sourceLineNo">035</span>public class SimpleNamedFilterList implements NamedFilterList {<a name="line.35"></a>
<span class="sourceLineNo">036</span><a name="line.36"></a>
<span class="sourceLineNo">037</span> private String name;<a name="line.37"></a>
<span class="sourceLineNo">038</span> private List&lt;Filter&gt; backingList;<a name="line.38"></a>
<span class="sourceLineNo">039</span><a name="line.39"></a>
<span class="sourceLineNo">040</span> /**<a name="line.40"></a>
<span class="sourceLineNo">041</span> * Creates a new {@code SimpleNamedFilterList} instance with the specified {@code name}, defaulting to a new<a name="line.41"></a>
<span class="sourceLineNo">042</span> * {@link ArrayList ArrayList} instance as the backing list.<a name="line.42"></a>
<span class="sourceLineNo">043</span> *<a name="line.43"></a>
<span class="sourceLineNo">044</span> * @param name the name to assign to this instance.<a name="line.44"></a>
<span class="sourceLineNo">045</span> * @throws IllegalArgumentException if {@code name} is null or empty.<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span> public SimpleNamedFilterList(String name) {<a name="line.47"></a>
<span class="sourceLineNo">048</span> this(name, new ArrayList&lt;Filter&gt;());<a name="line.48"></a>
<span class="sourceLineNo">049</span> }<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> /**<a name="line.51"></a>
<span class="sourceLineNo">052</span> * Creates a new {@code SimpleNamedFilterList} instance with the specified {@code name} and {@code backingList}.<a name="line.52"></a>
<span class="sourceLineNo">053</span> *<a name="line.53"></a>
<span class="sourceLineNo">054</span> * @param name the name to assign to this instance.<a name="line.54"></a>
<span class="sourceLineNo">055</span> * @param backingList the list instance used to back all of this class's {@link List} method implementations.<a name="line.55"></a>
<span class="sourceLineNo">056</span> * @throws IllegalArgumentException if {@code name} is null or empty.<a name="line.56"></a>
<span class="sourceLineNo">057</span> * @throws NullPointerException if the backing list is {@code null}.<a name="line.57"></a>
<span class="sourceLineNo">058</span> */<a name="line.58"></a>
<span class="sourceLineNo">059</span> public SimpleNamedFilterList(String name, List&lt;Filter&gt; backingList) {<a name="line.59"></a>
<span class="sourceLineNo">060</span> if (backingList == null) {<a name="line.60"></a>
<span class="sourceLineNo">061</span> throw new NullPointerException("backingList constructor argument cannot be null.");<a name="line.61"></a>
<span class="sourceLineNo">062</span> }<a name="line.62"></a>
<span class="sourceLineNo">063</span> this.backingList = backingList;<a name="line.63"></a>
<span class="sourceLineNo">064</span> setName(name);<a name="line.64"></a>
<span class="sourceLineNo">065</span> }<a name="line.65"></a>
<span class="sourceLineNo">066</span><a name="line.66"></a>
<span class="sourceLineNo">067</span> protected void setName(String name) {<a name="line.67"></a>
<span class="sourceLineNo">068</span> if (!StringUtils.hasText(name)) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> throw new IllegalArgumentException("Cannot specify a null or empty name.");<a name="line.69"></a>
<span class="sourceLineNo">070</span> }<a name="line.70"></a>
<span class="sourceLineNo">071</span> this.name = name;<a name="line.71"></a>
<span class="sourceLineNo">072</span> }<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> public String getName() {<a name="line.74"></a>
<span class="sourceLineNo">075</span> return name;<a name="line.75"></a>
<span class="sourceLineNo">076</span> }<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> public FilterChain proxy(FilterChain orig) {<a name="line.78"></a>
<span class="sourceLineNo">079</span> return new ProxiedFilterChain(orig, this);<a name="line.79"></a>
<span class="sourceLineNo">080</span> }<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> public boolean add(Filter filter) {<a name="line.82"></a>
<span class="sourceLineNo">083</span> return this.backingList.add(filter);<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> public void add(int index, Filter filter) {<a name="line.86"></a>
<span class="sourceLineNo">087</span> this.backingList.add(index, filter);<a name="line.87"></a>
<span class="sourceLineNo">088</span> }<a name="line.88"></a>
<span class="sourceLineNo">089</span><a name="line.89"></a>
<span class="sourceLineNo">090</span> public boolean addAll(Collection&lt;? extends Filter&gt; c) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> return this.backingList.addAll(c);<a name="line.91"></a>
<span class="sourceLineNo">092</span> }<a name="line.92"></a>
<span class="sourceLineNo">093</span><a name="line.93"></a>
<span class="sourceLineNo">094</span> public boolean addAll(int index, Collection&lt;? extends Filter&gt; c) {<a name="line.94"></a>
<span class="sourceLineNo">095</span> return this.backingList.addAll(index, c);<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> public void clear() {<a name="line.98"></a>
<span class="sourceLineNo">099</span> this.backingList.clear();<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> public boolean contains(Object o) {<a name="line.102"></a>
<span class="sourceLineNo">103</span> return this.backingList.contains(o);<a name="line.103"></a>
<span class="sourceLineNo">104</span> }<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span> public boolean containsAll(Collection&lt;?&gt; c) {<a name="line.106"></a>
<span class="sourceLineNo">107</span> return this.backingList.containsAll(c);<a name="line.107"></a>
<span class="sourceLineNo">108</span> }<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> public Filter get(int index) {<a name="line.110"></a>
<span class="sourceLineNo">111</span> return this.backingList.get(index);<a name="line.111"></a>
<span class="sourceLineNo">112</span> }<a name="line.112"></a>
<span class="sourceLineNo">113</span><a name="line.113"></a>
<span class="sourceLineNo">114</span> public int indexOf(Object o) {<a name="line.114"></a>
<span class="sourceLineNo">115</span> return this.backingList.indexOf(o);<a name="line.115"></a>
<span class="sourceLineNo">116</span> }<a name="line.116"></a>
<span class="sourceLineNo">117</span><a name="line.117"></a>
<span class="sourceLineNo">118</span> public boolean isEmpty() {<a name="line.118"></a>
<span class="sourceLineNo">119</span> return this.backingList.isEmpty();<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span><a name="line.121"></a>
<span class="sourceLineNo">122</span> public Iterator&lt;Filter&gt; iterator() {<a name="line.122"></a>
<span class="sourceLineNo">123</span> return this.backingList.iterator();<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> public int lastIndexOf(Object o) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> return this.backingList.lastIndexOf(o);<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span><a name="line.129"></a>
<span class="sourceLineNo">130</span> public ListIterator&lt;Filter&gt; listIterator() {<a name="line.130"></a>
<span class="sourceLineNo">131</span> return this.backingList.listIterator();<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span><a name="line.133"></a>
<span class="sourceLineNo">134</span> public ListIterator&lt;Filter&gt; listIterator(int index) {<a name="line.134"></a>
<span class="sourceLineNo">135</span> return this.backingList.listIterator(index);<a name="line.135"></a>
<span class="sourceLineNo">136</span> }<a name="line.136"></a>
<span class="sourceLineNo">137</span><a name="line.137"></a>
<span class="sourceLineNo">138</span> public Filter remove(int index) {<a name="line.138"></a>
<span class="sourceLineNo">139</span> return this.backingList.remove(index);<a name="line.139"></a>
<span class="sourceLineNo">140</span> }<a name="line.140"></a>
<span class="sourceLineNo">141</span><a name="line.141"></a>
<span class="sourceLineNo">142</span> public boolean remove(Object o) {<a name="line.142"></a>
<span class="sourceLineNo">143</span> return this.backingList.remove(o);<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span> public boolean removeAll(Collection&lt;?&gt; c) {<a name="line.146"></a>
<span class="sourceLineNo">147</span> return this.backingList.removeAll(c);<a name="line.147"></a>
<span class="sourceLineNo">148</span> }<a name="line.148"></a>
<span class="sourceLineNo">149</span><a name="line.149"></a>
<span class="sourceLineNo">150</span> public boolean retainAll(Collection&lt;?&gt; c) {<a name="line.150"></a>
<span class="sourceLineNo">151</span> return this.backingList.retainAll(c);<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span> public Filter set(int index, Filter filter) {<a name="line.154"></a>
<span class="sourceLineNo">155</span> return this.backingList.set(index, filter);<a name="line.155"></a>
<span class="sourceLineNo">156</span> }<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span> public int size() {<a name="line.158"></a>
<span class="sourceLineNo">159</span> return this.backingList.size();<a name="line.159"></a>
<span class="sourceLineNo">160</span> }<a name="line.160"></a>
<span class="sourceLineNo">161</span><a name="line.161"></a>
<span class="sourceLineNo">162</span> public List&lt;Filter&gt; subList(int fromIndex, int toIndex) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> return this.backingList.subList(fromIndex, toIndex);<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span> public Object[] toArray() {<a name="line.166"></a>
<span class="sourceLineNo">167</span> return this.backingList.toArray();<a name="line.167"></a>
<span class="sourceLineNo">168</span> }<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span> public &lt;T&gt; T[] toArray(T[] a) {<a name="line.170"></a>
<span class="sourceLineNo">171</span> //noinspection SuspiciousToArrayCall<a name="line.171"></a>
<span class="sourceLineNo">172</span> return this.backingList.toArray(a);<a name="line.172"></a>
<span class="sourceLineNo">173</span> }<a name="line.173"></a>
<span class="sourceLineNo">174</span>}<a name="line.174"></a>
</pre>
</div>
</body>
</html>