88a935b2a435f1832e40847b8f7532b770ccca25
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / arp / Rule.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.arp;
51
52 import java.net.URL;
53
54 import org.apache.xerces.parsers.DOMParser;
55 import org.w3c.dom.CharacterData;
56 import org.w3c.dom.Document;
57 import org.w3c.dom.Element;
58 import org.w3c.dom.Node;
59 import org.w3c.dom.NodeList;
60
61 /**
62  *  An Attribute Release Policy Rule.
63  *
64  * @author Walter Hoehn (wassa@columbia.edu)
65  */
66
67 public class Rule {
68
69         private String description;
70
71         /**
72          * Returns the description for this <code>Rule</code>.
73          * @return String
74          */
75
76         public String getDescription() {
77                 return description;
78         }
79
80         /**
81          * Sets the description for this <code>Rule</code>.
82          * @param description The description to set
83          */
84
85         public void setDescription(String description) {
86                 this.description = description;
87         }
88
89         /**
90          * Unmarshalls the <code>Rule</code> into an xml <code>Element</code>.
91          * @return the xml <code>Element</code>
92          */
93
94         public Element unmarshall() {
95
96                 DOMParser parser = new DOMParser();
97                 Document placeHolder = parser.getDocument();
98                 Element ruleNode = placeHolder.createElement("Rule");
99
100                 if (description != null) {
101                         Element descriptionNode = placeHolder.createElement("Description");
102                         descriptionNode.appendChild(placeHolder.createTextNode(description));
103                         ruleNode.appendChild(descriptionNode);
104                 }
105
106                 return ruleNode;
107         }
108
109         /**
110          * Creates an ARP Rule from an xml representation.
111          * @param the xml <code>Element</code> containing the ARP Rule.
112          */
113         
114         public void marshall(Element element) throws ArpMarshallingException {
115
116                 //Make sure we are deling with a Rule
117                 if (!element.getTagName().equals("Rule")) {
118                         throw new ArpMarshallingException("Element data does not represent an ARP Rule.");
119                 }
120
121                 //Grab the description
122                 NodeList descriptionNodes = element.getElementsByTagName("Description");
123                 if (descriptionNodes.getLength() > 0) {
124                         Element descriptionNode = (Element) descriptionNodes.item(0);
125                         if (descriptionNode.hasChildNodes()
126                                 && descriptionNode.getFirstChild().getNodeType() == Node.TEXT_NODE) {
127                                 description = ((CharacterData) descriptionNode.getFirstChild()).getData();
128                         }
129                 }
130         }
131
132         /**
133          * Method matchesRequest.
134          * @param requester
135          * @param resource
136          * @return boolean
137          */
138         public boolean matchesRequest(String requester, URL resource) {
139                 return false;
140         }
141
142 }