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.relyingparty;
19  
20  import java.util.Map;
21  
22  /**
23   * Locates the configuration for a given relying party.
24   */
25  public interface RelyingPartyConfigurationManager {
26  
27      /**
28       * Gets the configuration for the given relying party.
29       * 
30       * @param relyingPartyEntityID the entity of the relying part to get the configuration for
31       * 
32       * @return configuration for the given relying party
33       */
34      public RelyingPartyConfiguration getRelyingPartyConfiguration(String relyingPartyEntityID);
35  
36      /**
37       * Gets the registered relying party configurations indexed by relying party ID.
38       * 
39       * @return the registered relying party configurations
40       */
41      public Map<String, RelyingPartyConfiguration> getRelyingPartyConfigurations();
42  
43      /**
44       * Gets the default relying party configuration.
45       * 
46       * @return the default relying party configuration
47       */
48      public RelyingPartyConfiguration getDefaultRelyingPartyConfiguration();
49  
50      /**
51       * Gets the relying party configuration to use for anonymous parties.
52       * 
53       * @return the relying party configuration to use for anonymous parties
54       */
55      public RelyingPartyConfiguration getAnonymousRelyingConfiguration();
56  }