use the new session manager interface
[java-idp.git] / tests / edu / internet2 / middleware / shibboleth / aa / attrresolv / FileConnector.java
1 /*
2  * Copyright [2005] [University Corporation for Advanced Internet Development, Inc.]
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 /*
18  * Contributed by SungGard SCT.
19  */
20
21 package edu.internet2.middleware.shibboleth.aa.attrresolv;
22
23 import java.security.Principal;
24
25 import javax.naming.directory.Attributes;
26 import javax.naming.directory.BasicAttribute;
27 import javax.naming.directory.BasicAttributes;
28
29 import org.apache.log4j.Logger;
30 import org.w3c.dom.Element;
31
32 import edu.internet2.middleware.shibboleth.aa.attrresolv.provider.BaseResolutionPlugIn;
33
34 /**
35  * The FileConnector essentially returns the same attribute values for all principals/requestors. The returned
36  * attributes are specified in a file as name-value pairs separated by an 'equals' sign (=). The datafile is specified
37  * as an attribute on the definition of the FileConnector. Only one attribute, namely the eduPersonPrincipalName may
38  * take different values for different principals. If this attribute is not specified in the properties file (datafile),
39  * the principal name passed to the resolver is returned as EPPN. Multiple values of an attribute may be specified using
40  * multiple pairs with the same attribute name. Multi-valued attributes are not considered ordered by default (to
41  * emulate LDAP data connector) unless the attribute 'ordered' is set to true.
42  * 
43  * @author <a href="mailto:vgoenka@sungardsct.com">Vishal Goenka </a>
44  */
45
46 public class FileConnector extends BaseResolutionPlugIn implements DataConnectorPlugIn {
47
48         private static Logger log = Logger.getLogger(FileConnector.class.getName());
49         private Attributes attributes;
50
51         public FileConnector(Element e) throws ResolutionPlugInException {
52
53                 super(e);
54                 if (!e.hasAttribute("datafile"))
55                         throw new ResolutionPlugInException("datafile MUST be specified for FileConnector");
56                 String datafile = e.getAttribute("datafile");
57                 boolean ordered = false;
58                 if (e.hasAttribute("ordered")) ordered = Boolean.valueOf(e.getAttribute("ordered")).booleanValue();
59
60                 try {
61                         attributes = (new AttributesFile(datafile)).readAttributes(ordered);
62                 } catch (Exception ex) {
63                         log.error("Failed to read datafile <" + datafile + "> - " + ex.getMessage(), ex);
64                         throw new ResolutionPlugInException(ex.getMessage());
65                 }
66         }
67
68         /**
69          * @see edu.internet2.middleware.shibboleth.aa.attrresolv.DataConnectorPlugIn#resolve(Principal)
70          */
71         public Attributes resolve(Principal principal, String requester, String responder, Dependencies depends) {
72
73                 log.debug("Resolving connector: (" + getId() + ")");
74                 log.debug(getId() + " resolving for principal: (" + principal.getName() + ")");
75
76                 BasicAttributes attrs = (BasicAttributes) attributes.clone();
77                 BasicAttribute eppn = (BasicAttribute) attrs.get("eduPersonPrincipalName");
78                 if (eppn == null) {
79                         attrs.put(new BasicAttribute("eduPersonPrincipalName", principal.getName()));
80                 }
81                 return attrs;
82         }
83
84         /**
85          * @see edu.internet2.middleware.shibboleth.aa.attrresolv.DataConnectorPlugIn#getFailoverDependencyId()
86          */
87         public String getFailoverDependencyId() {
88
89                 return null;
90         }
91 }