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.principalConnector;
19  
20  import java.util.HashSet;
21  import java.util.Set;
22  
23  import edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.AbstractResolutionPlugIn;
24  
25  
26  /**
27   * Base class for {@link PrincipalConnector} plug-ins.
28   */
29  public abstract class BasePrincipalConnector extends AbstractResolutionPlugIn<String> implements
30          PrincipalConnector {
31      
32      /** NameID Format. */
33      private String format;
34  
35      /** Relying parties this connector is valid for. */
36      private Set<String> relyingParties;
37  
38      /** Constructor. */
39      public BasePrincipalConnector() {
40          relyingParties = new HashSet<String>();
41      }
42  
43      /**
44       * Set NameID format.
45       * 
46       * @param newFormat new NameID format
47       */
48      public void setFormat(String newFormat) {
49          format = newFormat;
50      }
51  
52      /** {@inheritDoc} */
53      public String getFormat() {
54          return format;
55      }
56  
57      /** {@inheritDoc} */
58      public Set<String> getRelyingParties() {
59          return relyingParties;
60      }  
61  }