a9ef3110a654c33af8a6d126bf8b4f1232b6acb0
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / Arp.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 Release Policy for a User
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 java.security.Principal;
64 import java.security.acl.*;
65
66 public class Arp extends ArpCore implements Serializable{
67         
68         static final long serialVersionUID = 1L;
69
70     // Attributes
71     protected String name;
72     protected boolean isAdmin;
73     private boolean everWritten = false;
74     private Date lastRead;
75     private boolean hasDefaultShar = false;
76     private ArpShar defaultShar;
77
78     // Associations
79     protected Vector  shars;
80
81     // Constructors
82     public Arp(String name, boolean isAdmin)
83         throws NotOwnerException{
84
85         this.name = name;
86         this.isAdmin = isAdmin;
87         shars  = new Vector();
88         makeAcl("arpAcl");
89     }
90
91     // Operations
92     public boolean isNew(){
93         return !everWritten;
94     }
95
96     public void setNew(boolean b){
97         everWritten = !b;
98     }
99
100     public void setLastRead(Date d){
101         lastRead = d;
102     }
103
104     public Date getLastRead(){
105         return lastRead;
106     }
107
108     /**
109      * Add a new SHAR to the list of SHARs for this ARP.
110      * returns false and does not replace if SHAR already exists.
111      */
112     public boolean addAShar(String name, boolean isDefault)
113         throws NotOwnerException,AAPermissionException, AAException{
114
115         if(isDefault && hasDefaultShar)
116             throw new AAException("Already has a Default SHAR");
117
118         ArpShar newShar = new ArpShar(name, isDefault);
119         if(shars.contains(newShar))
120             return false; // already there
121         if(! insertPermitted())
122             throw new AAPermissionException("No INSERT right for "+getCaller());
123         shars.add(newShar);
124         if(isDefault){
125             hasDefaultShar = true;
126             defaultShar = newShar;
127         }
128         return true;
129     }
130
131     /**
132      * Add the given SHAR to the list of SHARs for this ARP.
133      * returns false and does not replace if SHAR already exists.
134      */
135     public boolean addAShar(ArpShar shar)
136         throws AAPermissionException, AAException{
137
138         return addAShar(shar, false);
139     }
140
141     /**
142      * Adds the given shar to the shars for this Arp.
143      * if force flag is true and shar already exists
144      * then replaces the existing reource otherwise leaves the existing 
145      * shar untouched.  
146      * returns false if reource already existed.
147      * Throws AAPermissionException if caller is not permitted to insert or replace.
148      */
149     public boolean addAShar(ArpShar shar, boolean force)
150         throws AAPermissionException, AAException {
151                 
152         if(shars.contains(shar)){
153             if(force){
154                 if(! replacePermitted())
155                     throw new AAPermissionException("No replace right for "+getCaller());
156                 shars.remove(shar);
157                 shars.add(shar);
158             }
159             return false; // already there
160         }
161         if(! insertPermitted())
162             throw new AAPermissionException("No INSERT right for "+getCaller());
163         if(shar.isDefault() &&  hasDefaultShar)
164             throw new AAException("Already has a Default SHAR");
165
166         shars.add(shar);
167         if(shar.isDefault()){
168             hasDefaultShar = true;
169             defaultShar = shar;
170         }
171         return true;
172     }
173
174
175
176     public boolean removeAShar(String name)
177         throws NotOwnerException, AAPermissionException{
178
179         ArpShar newShar = new ArpShar(name, false);
180         if(shars.contains(newShar)){
181             if(! removePermitted())
182                 throw new AAPermissionException("No DELETE rights for "+getCaller());
183             shars.remove(newShar);
184             if(hasDefaultShar && newShar.equals(defaultShar)){
185                 defaultShar = null;
186                 hasDefaultShar = false;
187             }
188             return true;
189         }
190         return false; // not found
191     }
192
193
194     public ArpShar getShar(String name) {
195         Enumeration en = shars.elements();
196         while(en.hasMoreElements()){
197             ArpShar aShar = (ArpShar)en.nextElement();
198             if(aShar.getName().equals(name))
199                 return aShar;
200         }
201         return null;
202     }
203
204     public ArpShar[] getShars() {
205         int len = shars.size();
206         ArpShar[] a = new ArpShar[len];
207         for(int i = 0; i < len; i++)
208             a[i] = (ArpShar)shars.get(i);
209         return a;
210     }
211
212     public ArpShar getDefaultShar(){
213         return defaultShar;
214     }
215
216     public String getName(){
217         return name;
218     }
219
220     //public void setAcl(Acl acl){
221     //this.acl = acl;
222     //}
223
224     public String toString(){
225         return name+(isAdmin?"(admin)":"");
226     }
227
228     public boolean isAdmin(){
229         return isAdmin;
230     }
231
232     public boolean equals(Object arp){
233         return name.equals(((Arp)arp).getName());
234     }
235
236 } /* end class Arp */