blob: 860ac74dbf8dfd52d602566e7c70c6e8fbb485ce [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" />
<title>SimpleNamedFilterList xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/org/apache/shiro/web/filter/mgt/SimpleNamedFilterList.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="jxr_comment">/*</em>
<a name="2" href="#2">2</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="3" href="#3">3</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="5" href="#5">5</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> *</em>
<a name="10" href="#10">10</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="17" href="#17">17</a> <em class="jxr_comment"> * under the License.</em>
<a name="18" href="#18">18</a> <em class="jxr_comment"> */</em>
<a name="19" href="#19">19</a> <strong class="jxr_keyword">package</strong> org.apache.shiro.web.filter.mgt;
<a name="20" href="#20">20</a>
<a name="21" href="#21">21</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.util.StringUtils;
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> org.apache.shiro.web.servlet.ProxiedFilterChain;
<a name="23" href="#23">23</a>
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> javax.servlet.Filter;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> javax.servlet.FilterChain;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.*;
<a name="27" href="#27">27</a>
<a name="28" href="#28">28</a> <em class="jxr_javadoccomment">/**</em>
<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * Simple {@code NamedFilterList} implementation that is supported by a backing {@link List} instance and a simple</em>
<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * {@link #getName() name} property. All {@link List} method implementations are immediately delegated to the</em>
<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * wrapped backing list.</em>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> *</em>
<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * @since 1.0</em>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> */</em>
<a name="35" href="#35">35</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../org/apache/shiro/web/filter/mgt/SimpleNamedFilterList.html">SimpleNamedFilterList</a> implements <a href="../../../../../../org/apache/shiro/web/filter/mgt/NamedFilterList.html">NamedFilterList</a> {
<a name="36" href="#36">36</a>
<a name="37" href="#37">37</a> <strong class="jxr_keyword">private</strong> String name;
<a name="38" href="#38">38</a> <strong class="jxr_keyword">private</strong> List&lt;Filter&gt; backingList;
<a name="39" href="#39">39</a>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment">/**</em>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * Creates a new {@code SimpleNamedFilterList} instance with the specified {@code name}, defaulting to a new</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * {@link ArrayList ArrayList} instance as the backing list.</em>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> *</em>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * @param name the name to assign to this instance.</em>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code name} is null or empty.</em>
<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> */</em>
<a name="47" href="#47">47</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/shiro/web/filter/mgt/SimpleNamedFilterList.html">SimpleNamedFilterList</a>(String name) {
<a name="48" href="#48">48</a> <strong class="jxr_keyword">this</strong>(name, <strong class="jxr_keyword">new</strong> ArrayList&lt;Filter&gt;());
<a name="49" href="#49">49</a> }
<a name="50" href="#50">50</a>
<a name="51" href="#51">51</a> <em class="jxr_javadoccomment">/**</em>
<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> * Creates a new {@code SimpleNamedFilterList} instance with the specified {@code name} and {@code backingList}.</em>
<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> *</em>
<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @param name the name to assign to this instance.</em>
<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> * @param backingList the list instance used to back all of this class's {@link List} method implementations.</em>
<a name="56" href="#56">56</a> <em class="jxr_javadoccomment"> * @throws IllegalArgumentException if {@code name} is null or empty.</em>
<a name="57" href="#57">57</a> <em class="jxr_javadoccomment"> * @throws NullPointerException if the backing list is {@code null}.</em>
<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> */</em>
<a name="59" href="#59">59</a> <strong class="jxr_keyword">public</strong> <a href="../../../../../../org/apache/shiro/web/filter/mgt/SimpleNamedFilterList.html">SimpleNamedFilterList</a>(String name, List&lt;Filter&gt; backingList) {
<a name="60" href="#60">60</a> <strong class="jxr_keyword">if</strong> (backingList == <strong class="jxr_keyword">null</strong>) {
<a name="61" href="#61">61</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"backingList constructor argument cannot be null."</span>);
<a name="62" href="#62">62</a> }
<a name="63" href="#63">63</a> <strong class="jxr_keyword">this</strong>.backingList = backingList;
<a name="64" href="#64">64</a> setName(name);
<a name="65" href="#65">65</a> }
<a name="66" href="#66">66</a>
<a name="67" href="#67">67</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">void</strong> setName(String name) {
<a name="68" href="#68">68</a> <strong class="jxr_keyword">if</strong> (!StringUtils.hasText(name)) {
<a name="69" href="#69">69</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(<span class="jxr_string">"Cannot specify a null or empty name."</span>);
<a name="70" href="#70">70</a> }
<a name="71" href="#71">71</a> <strong class="jxr_keyword">this</strong>.name = name;
<a name="72" href="#72">72</a> }
<a name="73" href="#73">73</a>
<a name="74" href="#74">74</a> <strong class="jxr_keyword">public</strong> String getName() {
<a name="75" href="#75">75</a> <strong class="jxr_keyword">return</strong> name;
<a name="76" href="#76">76</a> }
<a name="77" href="#77">77</a>
<a name="78" href="#78">78</a> <strong class="jxr_keyword">public</strong> FilterChain proxy(FilterChain orig) {
<a name="79" href="#79">79</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../../../../org/apache/shiro/web/servlet/ProxiedFilterChain.html">ProxiedFilterChain</a>(orig, <strong class="jxr_keyword">this</strong>);
<a name="80" href="#80">80</a> }
<a name="81" href="#81">81</a>
<a name="82" href="#82">82</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> add(Filter filter) {
<a name="83" href="#83">83</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.add(filter);
<a name="84" href="#84">84</a> }
<a name="85" href="#85">85</a>
<a name="86" href="#86">86</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> add(<strong class="jxr_keyword">int</strong> index, Filter filter) {
<a name="87" href="#87">87</a> <strong class="jxr_keyword">this</strong>.backingList.add(index, filter);
<a name="88" href="#88">88</a> }
<a name="89" href="#89">89</a>
<a name="90" href="#90">90</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> addAll(Collection&lt;? <strong class="jxr_keyword">extends</strong> Filter&gt; c) {
<a name="91" href="#91">91</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.addAll(c);
<a name="92" href="#92">92</a> }
<a name="93" href="#93">93</a>
<a name="94" href="#94">94</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> addAll(<strong class="jxr_keyword">int</strong> index, Collection&lt;? <strong class="jxr_keyword">extends</strong> Filter&gt; c) {
<a name="95" href="#95">95</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.addAll(index, c);
<a name="96" href="#96">96</a> }
<a name="97" href="#97">97</a>
<a name="98" href="#98">98</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> clear() {
<a name="99" href="#99">99</a> <strong class="jxr_keyword">this</strong>.backingList.clear();
<a name="100" href="#100">100</a> }
<a name="101" href="#101">101</a>
<a name="102" href="#102">102</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> contains(Object o) {
<a name="103" href="#103">103</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.contains(o);
<a name="104" href="#104">104</a> }
<a name="105" href="#105">105</a>
<a name="106" href="#106">106</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> containsAll(Collection&lt;?&gt; c) {
<a name="107" href="#107">107</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.containsAll(c);
<a name="108" href="#108">108</a> }
<a name="109" href="#109">109</a>
<a name="110" href="#110">110</a> <strong class="jxr_keyword">public</strong> Filter get(<strong class="jxr_keyword">int</strong> index) {
<a name="111" href="#111">111</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.get(index);
<a name="112" href="#112">112</a> }
<a name="113" href="#113">113</a>
<a name="114" href="#114">114</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> indexOf(Object o) {
<a name="115" href="#115">115</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.indexOf(o);
<a name="116" href="#116">116</a> }
<a name="117" href="#117">117</a>
<a name="118" href="#118">118</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isEmpty() {
<a name="119" href="#119">119</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.isEmpty();
<a name="120" href="#120">120</a> }
<a name="121" href="#121">121</a>
<a name="122" href="#122">122</a> <strong class="jxr_keyword">public</strong> Iterator&lt;Filter&gt; iterator() {
<a name="123" href="#123">123</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.iterator();
<a name="124" href="#124">124</a> }
<a name="125" href="#125">125</a>
<a name="126" href="#126">126</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> lastIndexOf(Object o) {
<a name="127" href="#127">127</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.lastIndexOf(o);
<a name="128" href="#128">128</a> }
<a name="129" href="#129">129</a>
<a name="130" href="#130">130</a> <strong class="jxr_keyword">public</strong> ListIterator&lt;Filter&gt; listIterator() {
<a name="131" href="#131">131</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.listIterator();
<a name="132" href="#132">132</a> }
<a name="133" href="#133">133</a>
<a name="134" href="#134">134</a> <strong class="jxr_keyword">public</strong> ListIterator&lt;Filter&gt; listIterator(<strong class="jxr_keyword">int</strong> index) {
<a name="135" href="#135">135</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.listIterator(index);
<a name="136" href="#136">136</a> }
<a name="137" href="#137">137</a>
<a name="138" href="#138">138</a> <strong class="jxr_keyword">public</strong> Filter remove(<strong class="jxr_keyword">int</strong> index) {
<a name="139" href="#139">139</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.remove(index);
<a name="140" href="#140">140</a> }
<a name="141" href="#141">141</a>
<a name="142" href="#142">142</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> remove(Object o) {
<a name="143" href="#143">143</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.remove(o);
<a name="144" href="#144">144</a> }
<a name="145" href="#145">145</a>
<a name="146" href="#146">146</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> removeAll(Collection&lt;?&gt; c) {
<a name="147" href="#147">147</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.removeAll(c);
<a name="148" href="#148">148</a> }
<a name="149" href="#149">149</a>
<a name="150" href="#150">150</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> retainAll(Collection&lt;?&gt; c) {
<a name="151" href="#151">151</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.retainAll(c);
<a name="152" href="#152">152</a> }
<a name="153" href="#153">153</a>
<a name="154" href="#154">154</a> <strong class="jxr_keyword">public</strong> Filter set(<strong class="jxr_keyword">int</strong> index, Filter filter) {
<a name="155" href="#155">155</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.set(index, filter);
<a name="156" href="#156">156</a> }
<a name="157" href="#157">157</a>
<a name="158" href="#158">158</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> size() {
<a name="159" href="#159">159</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.size();
<a name="160" href="#160">160</a> }
<a name="161" href="#161">161</a>
<a name="162" href="#162">162</a> <strong class="jxr_keyword">public</strong> List&lt;Filter&gt; subList(<strong class="jxr_keyword">int</strong> fromIndex, <strong class="jxr_keyword">int</strong> toIndex) {
<a name="163" href="#163">163</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.subList(fromIndex, toIndex);
<a name="164" href="#164">164</a> }
<a name="165" href="#165">165</a>
<a name="166" href="#166">166</a> <strong class="jxr_keyword">public</strong> Object[] toArray() {
<a name="167" href="#167">167</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.toArray();
<a name="168" href="#168">168</a> }
<a name="169" href="#169">169</a>
<a name="170" href="#170">170</a> <strong class="jxr_keyword">public</strong> &lt;T&gt; T[] toArray(T[] a) {
<a name="171" href="#171">171</a> <em class="jxr_comment">//noinspection SuspiciousToArrayCall</em>
<a name="172" href="#172">172</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">this</strong>.backingList.toArray(a);
<a name="173" href="#173">173</a> }
<a name="174" href="#174">174</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>