8817142a271525138d1f833c4c4b163eef1bc6fd
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / attrresolv / provider / BaseResolutionPlugIn.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.attrresolv.provider;
51
52 import org.apache.log4j.Logger;
53 import org.w3c.dom.Element;
54
55 import edu.internet2.middleware.shibboleth.aa.attrresolv.ResolutionPlugInException;
56
57 /**
58  * Base class for Resolution PlugIns, both <code>AttributeDefinitionPlugIn</code> & <code>DataConnectorPlugIn</code>
59  * 
60  * @author Walter Hoehn (wassa@columbia.edu)
61  */
62
63 public abstract class BaseResolutionPlugIn {
64
65         private static Logger log = Logger.getLogger(BaseResolutionPlugIn.class.getName());
66         
67         /** The identifier for this PlugIn. */
68         protected String id;
69
70         /** Time, in seconds, for which the Attribute Resolver should cache resolutions of this PlugIn. */
71         protected long ttl = 0;
72
73         protected BaseResolutionPlugIn(Element e) throws ResolutionPlugInException {
74                 String id = e.getAttribute("id");
75                 if (id == null || id.equals("")) {
76                         log.error("Attribute \"id\" required to configure plugin.");
77                         throw new ResolutionPlugInException("Failed to initialize Resolution PlugIn.");
78                 }
79                 this.id = id;
80
81                 String cacheTime = e.getAttribute("cacheTime");
82                 if (cacheTime != null && !cacheTime.equals("")) {
83                         try {
84                                 this.ttl = Long.parseLong(cacheTime);
85                         } catch (NumberFormatException nfe) {
86                                 log.error("Attribute \"cacheTime\" must be an integer between 0 and " + Long.MAX_VALUE + ".");
87                                 throw new ResolutionPlugInException("Failed to initialize Resolution PlugIn.");
88                         }
89                 }
90         }
91         
92         /** Returns the identifier for this PlugIn. */
93         public String getId() {
94                 return id;
95         }
96
97         /** Returns the time, in seconds, for which the Attribute Resolver should cache resolutions of this PlugIn. */
98         public long getTTL() {
99                 return ttl;
100         }
101
102 }