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