View Javadoc

1   /*
2    * Licensed to the University Corporation for Advanced Internet Development, 
3    * Inc. (UCAID) under one or more contributor license agreements.  See the 
4    * NOTICE file distributed with this work for additional information regarding
5    * copyright ownership. The UCAID licenses this file to You under the Apache 
6    * License, Version 2.0 (the "License"); you may not use this file except in 
7    * compliance with the License.  You may obtain a copy of the License at
8    *
9    *    http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  
18  package edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.dataConnector;
19  
20  import java.util.List;
21  import java.util.Map;
22  
23  import edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute;
24  import edu.internet2.middleware.shibboleth.common.attribute.resolver.AttributeResolutionException;
25  import edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.ShibbolethResolutionContext;
26  
27  /**
28   * Wrapper for a {@link DataConnector} within a resolution context. This wrapper ensures that the connector is resolved
29   * only once per context.
30   */
31  public class ContextualDataConnector implements DataConnector {
32  
33      /** Wrapped data connector. */
34      private DataConnector connector;
35  
36      /** Cached result of resolving the data connector. */
37      private Map<String, BaseAttribute> attributes;
38  
39      /**
40       * Constructor.
41       * 
42       * @param newConnector data connector to wrap
43       */
44      public ContextualDataConnector(DataConnector newConnector) {
45          this.connector = newConnector;
46      }
47  
48      /** {@inheritDoc} */
49      public boolean equals(Object obj) {
50          return connector.equals(obj);
51      }
52  
53      /** {@inheritDoc} */
54      public int hashCode() {
55          return connector.hashCode();
56      }
57  
58      /** {@inheritDoc} */
59      public List<String> getDependencyIds() {
60          return connector.getDependencyIds();
61      }
62  
63      /** {@inheritDoc} */
64      public String getFailoverDependencyId() {
65          return connector.getFailoverDependencyId();
66      }
67  
68      /** {@inheritDoc} */
69      public String getId() {
70          return connector.getId();
71      }
72  
73      /** {@inheritDoc} */
74      public Map<String, BaseAttribute> resolve(ShibbolethResolutionContext resolutionContext)
75              throws AttributeResolutionException {
76          if (attributes == null) {
77              attributes = connector.resolve(resolutionContext);
78          }
79  
80          return attributes;
81      }
82  
83      /** {@inheritDoc} */
84      public void validate() throws AttributeResolutionException {
85          connector.validate();
86      }
87  }