Added hardcoded id to all classes involved in ARP serialiazation. Intended to fix...
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / ArpAttribute.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  *  Attribute node in 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 import javax.naming.directory.*;
64
65 public class ArpAttribute implements Serializable{
66
67         static final long serialVersionUID = 1L;
68         
69     // Attributes
70     protected String ID;
71     protected boolean exclude;
72
73     // Associations
74     protected ArpFilter filter;
75
76     // Constructor
77     public ArpAttribute(String ID, boolean exclude){
78         this.ID = ID;
79         this.exclude = exclude;
80     }
81
82     // Operations
83     public Attribute getDirAttribute(DirContext ctx, boolean doFilter)
84         throws javax.naming.NamingException{
85
86         String[] ids = new String[1];
87         ids[0] = ID;
88         Attributes attrs = ctx.getAttributes("", ids);
89         Attribute attr = attrs.get(ID);
90
91         if(doFilter && hasFilter()){
92             ArpFilterValue[] fvArray = filter.getFilterValues();
93             for(int i=0; i < fvArray.length; i++){
94                 if(fvArray[i].mustInclude())
95                     ; //skip. do not filter.
96                 else
97                     attr.remove(fvArray[i].getValue());
98             }
99         }
100         return attr;
101     }
102
103
104     public String getName(){
105         return ID;
106     }
107
108     /**
109      * lists all known attribute names.  Probably by consulting a 
110      * database or LDAP schemas
111      */
112     public String[] list(){
113         return null;
114     }
115
116     public boolean hasFilter(){
117         if(filter == null)
118             return false;
119         return true;
120     }
121
122     public ArpFilter getFilter(){
123         return filter;
124     }
125
126     /**
127      * sets a filter for this attribute.  returns true if succeeds
128      * returns false if there is already a filter set.
129      * If flag Force is true it replaces the existing filter,
130      * otherwise does not replace the existing filter.
131      */
132     public boolean setFilter(ArpFilter filter, boolean force){
133         if(hasFilter()){
134             if(force)
135                 this.filter = filter;
136             return false;
137         }
138         this.filter = filter;
139         return true;
140     }
141     
142     public boolean mustExclude(){
143         return exclude;
144     }
145
146     public boolean equals(Object attr){
147         return ID.equals(((ArpAttribute)attr).getName());
148     }
149
150     public int hashCode(){
151         return ID.hashCode();
152     }
153
154     public String toString(){
155         return ID+(exclude?"(exclude)":"");
156     }
157
158 } /* end class ArpAttribute */