Added hardcoded id to all classes involved in ARP serialiazation. Intended to fix...
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / ArpFilter.java
1 /* 
2  * The Shibboleth License, Version 1. 
3  * Copyright (c) 2002 
4  * University Corporation for Advanced Internet Development, Inc. 
5  * All rights reserved
6  * 
7  * 
8  * Redistribution and use in source and binary forms, with or without 
9  * modification, are permitted provided that the following conditions are met:
10  * 
11  * Redistributions of source code must retain the above copyright notice, this 
12  * list of conditions and the following disclaimer.
13  * 
14  * Redistributions in binary form must reproduce the above copyright notice, 
15  * this list of conditions and the following disclaimer in the documentation 
16  * and/or other materials provided with the distribution, if any, must include 
17  * the following acknowledgment: "This product includes software developed by 
18  * the University Corporation for Advanced Internet Development 
19  * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement 
20  * may appear in the software itself, if and wherever such third-party 
21  * acknowledgments normally appear.
22  * 
23  * Neither the name of Shibboleth nor the names of its contributors, nor 
24  * Internet2, nor the University Corporation for Advanced Internet Development, 
25  * Inc., nor UCAID may be used to endorse or promote products derived from this 
26  * software without specific prior written permission. For written permission, 
27  * please contact shibboleth@shibboleth.org
28  * 
29  * Products derived from this software may not be called Shibboleth, Internet2, 
30  * UCAID, or the University Corporation for Advanced Internet Development, nor 
31  * may Shibboleth appear in their name, without prior written permission of the 
32  * University Corporation for Advanced Internet Development.
33  * 
34  * 
35  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
36  * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
37  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
38  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK 
39  * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE. 
40  * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY 
41  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT, 
42  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
43  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
44  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
47  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48  */
49
50 package edu.internet2.middleware.shibboleth.aa;
51
52 /**
53  *  Attribute Authority & Release Policy
54  *  Filter node in the ARP tree.
55  *
56  * @author     Parviz Dousti (dousti@cmu.edu)
57  * @created    June, 2002
58  */
59
60
61 import java.io.*;
62 import java.util.*;
63 public class ArpFilter implements Serializable{
64
65         static final long serialVersionUID = 1L;
66         
67     // Associations
68     protected Vector values;
69     
70     // Constructor
71     public ArpFilter(){
72         values = new Vector();
73     }
74
75     // Operations
76     public ArpFilterValue[] getFilterValues() {
77         ArpFilterValue[] afva = new ArpFilterValue[values.size()];
78         return (ArpFilterValue[])values.toArray(afva);
79     }
80
81     public boolean addAFilterValue(ArpFilterValue afv) {
82         return addAFilterValue(afv, false);
83     }
84
85     /**
86      * Adds the given value to the values for this Filter.
87      * if force flag is true and value already exists
88      * then replaces the existing reource otherwise leaves the existing 
89      * value untouched.  
90      * returns false if reource already existed.
91      */
92     public boolean addAFilterValue(ArpFilterValue afv, boolean force) {
93         if(values.contains(afv)){
94             if(force){
95                 values.remove(afv);
96                 values.add(afv);
97             }
98             return false; // already there
99         }
100         values.add(afv);
101         return true;
102     }
103
104     public boolean removeFilterValue(ArpFilterValue afv) {
105         if(values.contains(afv)){
106             values.remove(afv);
107             return true;
108         }
109         return false; // not found
110     }
111
112     public boolean contains(ArpFilterValue afv) {
113         return values.contains(afv);
114     }
115
116     public ArpFilterValue[] getInclusions() {
117         Vector incs = new Vector();
118         Enumeration en = values.elements();
119         while(en.hasMoreElements()){
120             ArpFilterValue afv = (ArpFilterValue)en.nextElement();
121             if(afv.mustInclude())
122                 incs.add(afv);
123         }
124         return (ArpFilterValue[])incs.toArray();
125     }
126  
127     
128     public String toString(){
129         StringBuffer buf = new StringBuffer();
130         Enumeration en = values.elements();
131         while(en.hasMoreElements()){
132             buf.append((ArpFilterValue)en.nextElement());
133             buf.append(", ");
134         }
135         return buf.toString();
136     }
137         
138
139 } /* end class ArpFilter */