Push SAML Attribute namespace configuration into the resolver. (Needed for proper...
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / attrresolv / provider / BaseAttributeDefinition.java
1 /*
2  * The Shibboleth License, Version 1. Copyright (c) 2002 University Corporation for Advanced Internet Development, Inc.
3  * All rights reserved Redistribution and use in source and binary forms, with or without modification, are permitted
4  * provided that the following conditions are met: Redistributions of source code must retain the above copyright
5  * notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above
6  * copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials
7  * provided with the distribution, if any, must include the following acknowledgment: "This product includes software
8  * developed by the University Corporation for Advanced Internet Development <http://www.ucaid.edu>Internet2 Project.
9  * Alternately, this acknowledegement may appear in the software itself, if and wherever such third-party
10  * acknowledgments normally appear. Neither the name of Shibboleth nor the names of its contributors, nor Internet2, nor
11  * the University Corporation for Advanced Internet Development, Inc., nor UCAID may be used to endorse or promote
12  * products derived from this software without specific prior written permission. For written permission, please contact
13  * shibboleth@shibboleth.org Products derived from this software may not be called Shibboleth, Internet2, UCAID, or the
14  * University Corporation for Advanced Internet Development, nor may Shibboleth appear in their name, without prior
15  * written permission of the University Corporation for Advanced Internet Development. THIS SOFTWARE IS PROVIDED BY THE
16  * COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE
18  * DISCLAIMED AND THE ENTIRE RISK OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE. IN NO
19  * EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC.
20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
23  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 package edu.internet2.middleware.shibboleth.aa.attrresolv.provider;
27
28 import org.apache.log4j.Logger;
29 import org.w3c.dom.Element;
30
31 import edu.internet2.middleware.shibboleth.aa.attrresolv.AttributeDefinitionPlugIn;
32 import edu.internet2.middleware.shibboleth.aa.attrresolv.ResolutionPlugInException;
33 import edu.internet2.middleware.shibboleth.aa.attrresolv.ResolverAttribute;
34
35 /**
36  * Base class for Attribute Definition PlugIns. Provides basic functionality such as dependency mapping. Subclasses must
37  * provide resolution logic.
38  * 
39  * @author Walter Hoehn (wassa@columbia.edu)
40  */
41
42 public abstract class BaseAttributeDefinition extends BaseResolutionPlugIn implements AttributeDefinitionPlugIn {
43
44         /** The time, in seconds, for which attribute created from this definition should be valid. */
45         protected long lifeTime = -1;
46         public final static String SHIB_ATTRIBUTE_NAMESPACE_URI = "urn:mace:shibboleth:1.0:attributeNamespace:uri";
47         protected String namespace = SHIB_ATTRIBUTE_NAMESPACE_URI;
48
49         private static Logger log = Logger.getLogger(BaseAttributeDefinition.class.getName());
50
51         protected BaseAttributeDefinition(Element e) throws ResolutionPlugInException {
52
53                 super(e);
54
55                 String lifeTimeSpec = e.getAttribute("lifeTime");
56                 if (lifeTimeSpec != null && !lifeTimeSpec.equals("")) {
57                         try {
58                                 lifeTime = Long.valueOf(lifeTimeSpec).longValue();
59                                 log.debug("Explicit lifetime set for attribute (" + getId() + ").  Lifetime: (" + lifeTime + ").");
60                         } catch (NumberFormatException nfe) {
61                                 log.error("Bad value for attribute (lifeTime) for Attribute Definition (" + getId() + ").");
62                         }
63                 }
64
65                 String namespaceSpec = e.getAttribute("namespace");
66                 if (namespaceSpec != null && !namespaceSpec.equals("")) {
67                         namespace = namespaceSpec;
68                 }
69         }
70
71         /**
72          * Should be run by all sublcasses during resolution.
73          */
74         protected void standardProcessing(ResolverAttribute attr) {
75
76                 if (lifeTime != -1) {
77                         attr.setLifetime(lifeTime);
78                 }
79
80                 attr.setNamespace(namespace);
81         }
82 }