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