Added hardcoded id to all classes involved in ARP serialiazation. Intended to fix...
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / ArpShar.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  *  Shar node in ARP tree.
55  *
56  * @author     Parviz Dousti (dousti@cmu.edu)
57  * @created    June, 2002
58  */
59
60 import java.io.*;
61 import java.util.*;
62 import java.security.acl.*;
63
64 public class ArpShar extends ArpCore implements Serializable{
65
66         static final long serialVersionUID = 1L;
67
68     // Attributes
69     protected String name;
70     protected boolean isDefault;
71
72     // Associations
73     protected Vector  resources;
74     protected AA_Acl acl;
75
76     // Construstor
77     public ArpShar(String name, boolean isDefault)throws NotOwnerException{
78         this.name = name;
79         this.isDefault = isDefault;
80         resources  = new Vector();
81         makeAcl("sharAcl");
82     }
83
84     // Operations
85     public String toString() {
86         return name+(isDefault?"(default)":"");
87     }
88
89     public boolean isDefault(){
90         return isDefault;
91     }
92
93     public boolean addAResource(String url)
94         throws NotOwnerException,AAPermissionException{
95
96         if(resources.contains(new ArpResource(url)))
97             return false; // already there
98
99         if(! insertPermitted())
100             throw new AAPermissionException("No INSERT right for "+getCaller());
101
102         resources.add(new ArpResource(url));
103         return true;
104     }
105
106     /**
107      * Adds a given resource to the resources for this Shar.
108      * Does not replace if resource already exists.
109      * returns false if resource already exists.
110      */
111
112     public boolean addAResource(ArpResource rsrc) 
113         throws AAPermissionException{
114         return addAResource(rsrc, false);
115     }
116
117     /**
118      * Adds the given resource to the resources for this Shar.
119      * if force flag is true and resource already exists
120      * then replaces the existing reource otherwise leaves the existing 
121      * resource untouched.  
122      * returns false if reource already existed.
123      */
124     public boolean addAResource(ArpResource rsrc, boolean force)
125         throws AAPermissionException{
126
127         if(resources.contains(rsrc)){
128             if(force){
129                 if(! replacePermitted())
130                     throw new AAPermissionException("No replace right for "+getCaller());
131                 resources.remove(rsrc);
132                 resources.add(rsrc);
133             }
134             return false; // already there
135         }
136         if(! insertPermitted())
137             throw new AAPermissionException("No INSERT right for "+getCaller());
138         resources.add(rsrc);
139         return true;
140     }
141
142     public boolean removeAResource(String url)
143         throws NotOwnerException, AAPermissionException{
144         if(resources.contains(new ArpResource(url))){
145             if(! removePermitted())
146                 throw new AAPermissionException("No DELETE right for "+getCaller());
147             resources.remove(new ArpResource(url));
148             return true;
149         }
150         return false; // not found
151     }
152
153     public ArpResource getResource(String url) {
154         Enumeration en = resources.elements();
155         while(en.hasMoreElements()){
156             ArpResource aResource = (ArpResource)en.nextElement();
157             if(aResource.getName().equals(url))
158                 return aResource;
159         }
160         return null;
161     }
162
163     public ArpResource[] getResources() {
164         int len = resources.size();
165         ArpResource[] a = new ArpResource[len];
166         for(int i = 0; i < len; i++)
167             a[i] = (ArpResource)resources.get(i);
168         return a;
169     }
170
171
172     /**
173      * Go throu all resource objects and find the one that
174      * best matches the given url.  This is based on comparison 
175      * of TNames of urls provided by fit method of ArpResource.
176      *
177      * returns an ArpResource or null if no match found;
178      */
179     public ArpResource bestFit(String url) {
180
181         ArpResource[] ara = new ArpResource[resources.size()];
182         ara = (ArpResource[])resources.toArray(ara);
183         int bestScore = 0;
184         ArpResource bestResource = null;
185         for(int i=0; i < ara.length; i++){
186             int score =  ara[i].fit(url);
187             if(score > bestScore){
188                 bestScore = score;
189                 bestResource = ara[i];
190             }
191         }
192         return bestResource;
193     }
194
195     public String getName(){
196         return name;
197     }
198
199     public boolean equals(Object shar){
200         return name.equals(((ArpShar)shar).getName());
201     }
202
203 } /* end class ArpShar */