src/edu/internet2/middleware/shibboleth/aa/attrresolv/provider/BaseAttributeDefinition.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 java.util.HashSet;
  53 import java.util.Set;
  54
  55 import org.apache.log4j.Logger;
  56 import org.w3c.dom.Element;
  57 import org.w3c.dom.NodeList;
  58
  59 import edu.internet2.middleware.shibboleth.aa.attrresolv.AttributeDefinitionPlugIn;
  60 import edu.internet2.middleware.shibboleth.aa.attrresolv.AttributeResolver;
  61 import edu.internet2.middleware.shibboleth.aa.attrresolv.ResolutionPlugInException;
  62
  63 /**
  64  * Base class for Attribute Definition PlugIns.  Provides basic functionality such as
  65  * dependency mapping.  Subclasses must provide resolution logic.
  66  *
  67  * @author Walter Hoehn (wassa@columbia.edu)
  68  */
  69
  70 public abstract class BaseAttributeDefinition extends BaseResolutionPlugIn implements AttributeDefinitionPlugIn {
  71
  72         /** The time, in seconds, for which attribute created from this definition should be valid. */
  73         protected long lifeTime = -1;
  74
  75         private static Logger log = Logger.getLogger(BaseAttributeDefinition.class.getName());
  76         protected Set connectorDependencyIds = new HashSet();
  77         protected Set attributeDependencyIds = new HashSet();
  78
  79         protected BaseAttributeDefinition(Element e) throws ResolutionPlugInException {
  80
  81                 super(e);
  82
  83                 String lifeTimeSpec = e.getAttribute("lifeTime");
  84                 if (lifeTimeSpec != null && !lifeTimeSpec.equals("")) {
  85                         try {
  86                                 lifeTime = Long.valueOf(lifeTimeSpec).longValue();
  87                                 log.debug("Explicit lifetime set for attribute (" + getId() + ").  Lifetime: (" + lifeTime + ").");
  88                         } catch (NumberFormatException nfe) {
  89                                 log.error("Bad value for attribute (lifeTime) for Attribute Definition (" + getId() + ").");
  90                         }
  91                 }
  92
  93                 NodeList connectorNodes = e.getElementsByTagNameNS(AttributeResolver.resolverNamespace, "DataConnectorDependency");
  94
  95                 for (int i = 0; connectorNodes.getLength() > i; i++) {
  96                         Element connector = (Element) connectorNodes.item(i);
  97                         String connectorName = connector.getAttribute("requires");
  98                         if (connectorName != null && !connectorName.equals("")) {
  99                                 addDataConnectorDependencyId(connectorName);
 100                         } else {
 101                                 log.error("Data Connector dependency must be accomanied by a \"requires\" attribute.");
 102                                 throw new ResolutionPlugInException("Failed to initialize Attribute PlugIn.");
 103                         }
 104                 }
 105
 106                 NodeList attributeNodes = e.getElementsByTagNameNS(AttributeResolver.resolverNamespace, "AttributeDependency");
 107                 for (int i = 0; attributeNodes.getLength() > i; i++) {
 108                         Element attribute = (Element) attributeNodes.item(i);
 109                         String attributeName = attribute.getAttribute("requires");
 110                         if (attributeName != null && !attributeName.equals("")) {
 111                                 addAttributeDefinitionDependencyId(attributeName);
 112                         } else {
 113                                 log.error("Attribute Definition dependency must be accomanied by a \"requires\" attribute.");
 114                                 throw new ResolutionPlugInException("Failed to initialize Attribute PlugIn.");
 115                         }
 116                 }
 117
 118                 if (connectorNodes.getLength() == 0 && attributeNodes.getLength() == 0) {
 119                         log.warn("Attribute " + getId() + " has no registered dependencies.");
 120                 }
 121
 122         }
 123
 124         protected void addDataConnectorDependencyId(String id) {
 125                 connectorDependencyIds.add(id);
 126         }
 127
 128         protected void addAttributeDefinitionDependencyId(String id) {
 129                 attributeDependencyIds.add(id);
 130         }
 131
 132         /**
 133          * @see edu.internet2.middleware.shibboleth.aa.attrresolv.AttributeDefinitionPlugIn#getAttributeDependencyIds()
 134          */
 135         public String[] getAttributeDefinitionDependencyIds() {
 136                 return (String[]) attributeDependencyIds.toArray(new String[0]);
 137         }
 138
 139         /**
 140          * @see edu.internet2.middleware.shibboleth.aa.attrresolv.AttributeDefinitionPlugIn#getConnectorDependencyIds()
 141          */
 142         public String[] getDataConnectorDependencyIds() {
 143                 return (String[]) connectorDependencyIds.toArray(new String[0]);
 144         }
 145
 146 }