View Javadoc

1   /*
2    * Copyright [2007] [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  package edu.internet2.middleware.shibboleth.common.config.attribute.resolver.principalConnector;
18  
19  import org.opensaml.xml.util.DatatypeHelper;
20  
21  import edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.principalConnector.BasePrincipalConnector;
22  import edu.internet2.middleware.shibboleth.common.config.attribute.resolver.AbstractResolutionPluginFactoryBean;
23  
24  /**
25   * Base Spring factory bean that produces principal connectors.
26   */
27  public abstract class BasePrincipalConnectorFactoryBean extends AbstractResolutionPluginFactoryBean {
28  
29      /** Format of the NameID the connector operates on. */
30      private String nameIdFormat;
31  
32      /**
33       * Gets the format of the NameID the connector operates on.
34       * 
35       * @return format of the NameID the connector operates on
36       */
37      public String getNameIdFormat() {
38          return nameIdFormat;
39      }
40  
41      /**
42       * Sets the format of the NameID the connector operates on.
43       * 
44       * @param format format of the NameID the connector operates on
45       */
46      public void setNameIdFormat(String format) {
47          nameIdFormat = DatatypeHelper.safeTrimOrNullString(format);
48      }
49  
50      /**
51       * Populates the given connector with information from this factory.
52       * 
53       * @param connector connector populates
54       */
55      protected void populatePrincipalConnector(BasePrincipalConnector connector) {
56          connector.setId(getPluginId());
57          connector.setFormat(getNameIdFormat());
58          
59          if(getDependencyIds() != null){
60              connector.getDependencyIds().addAll(getDependencyIds());
61          }
62      }
63  }