1 files changed, 164 insertions, 0 deletions
diff --git a/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/ISpConfiguration.java b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/ISpConfiguration.java
new file mode 100644
index 00000000..5a16f655
--- /dev/null
+++ b/eaaf_core_api/src/main/java/at/gv/egiz/eaaf/core/api/idp/ISpConfiguration.java
@@ -0,0 +1,164 @@
+/*
+ * Copyright 2017 Graz University of Technology EAAF-Core Components has been developed in a
+ * cooperation between EGIZ, A-SIT Plus, A-SIT, and Graz University of Technology.
+ *
+ * Licensed under the EUPL, Version 1.2 or - as soon they will be approved by the European
+ * Commission - subsequent versions of the EUPL (the "Licence"); You may not use this work except in
+ * compliance with the Licence. You may obtain a copy of the Licence at:
+ * https://joinup.ec.europa.eu/news/understanding-eupl-v12
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the Licence
+ * is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
+ * or implied. See the Licence for the specific language governing permissions and limitations under
+ * the Licence.
+ *
+ * This product combines work with different licenses. See the "NOTICE" text file for details on the
+ * various modules and licenses. The "NOTICE" text file is part of the distribution. Any derivative
+ * works that you distribute must include a readable copy of the "NOTICE" text file.
+*/
+
+package at.gv.egiz.eaaf.core.api.idp;
+
+import java.io.Serializable;
+import java.util.List;
+import java.util.Map;
+
+public interface ISpConfiguration extends Serializable {
+
+  String CONFIG_KEY_RESTRICTIONS_BASEID_INTERNAL = "configuration.restrictions.baseID.idpProcessing";
+  String CONFIG_KEY_RESTRICTIONS_BASEID_TRANSMISSION = "configuration.restrictions.baseID.spTransmission";
+
+  String CONFIG_KEY_RESTRICTIONS_EID_DEMO_MODE = "configuration.restrictions.eIDTestMode";
+
+  /**
+   * Get the full key/value configuration for this Service Provider.
+   *
+   * @return an unmodifiable map of key/value pairs
+   */
+  Map<String, String> getFullConfiguration();
+
+  /**
+   * Get a configuration value from Service Provider key/value configuration.
+   *
+   * @param key The key identifier of a configuration value
+   * @return The configuration value {String} or null if the key does not exist
+   */
+  String getConfigurationValue(String key);
+
+  /**
+   * Get a configuration value from Service Provider key/value configuration.
+   *
+   * @param key          The key identifier of a configuration value
+   * @param defaultValue Default value if key does not exist
+   * @return The configuration value {String} or defaultValue if the key does not
+   *         exist
+   */
+  String getConfigurationValue(String key, String defaultValue);
+
+  /**
+   * Get a boolean configuration value from Service Provider key/value
+   * configuration.
+   *
+   * @param key The key identifier of a configuration value
+   * @return true / false, or false if the key does not exist
+   */
+  boolean isConfigurationValue(String key);
+
+  /**
+   * Get a boolean configuration value from Service Provider key/value
+   * configuration.
+   *
+   * @param key          The key identifier of a configuration value
+   * @param defaultValue Default value if key does not exist
+   * @return true / false, or defaultValue if the key does not exist
+   */
+  boolean isConfigurationValue(String key, boolean defaultValue);
+
+  /**
+   * Check if a configuration key is available in this Service Provider
+   * configuration.
+   *
+   * @param key The key identifier of a configuration value
+   * @return true if the configuration key exists, otherwise false
+   */
+  boolean containsConfigurationKey(String key);
+
+  /**
+   * Return the unique identifier of this Service Provider.
+   *
+   * @return
+   */
+  String getUniqueIdentifier();
+
+  /**
+   * Return the unique identifier of this Service Provider.
+   *
+   * @return
+   */
+  String getFriendlyName();
+
+  /**
+   * Indicates if this service provider has private area restrictions that
+   * disallow baseId. processing in general *
+   *
+   * @return true if there is a restriction, otherwise false
+   */
+  boolean hasBaseIdInternalProcessingRestriction();
+
+  /**
+   * Indicates if this service provider has private area restrictions that
+   * disallow baseId transfer. to SP
+   *
+   * @return true if there is a restriction, otherwise false
+   */
+  boolean hasBaseIdTransferRestriction();
+
+  /**
+   * Get the {@link List} of identifier's that indicates no baseID processing
+   * restriction exists.<br>
+   * This list can be configured by key:
+   * "configuration.restrictions.baseID.idpProcessing"
+   *
+   * @return
+   */
+  List<String> getTargetsWithNoBaseIdInternalProcessingRestriction();
+
+  /**
+   * Get the {@link List} of identifier's that indicates no baseID transfer
+   * restriction exists.<br>
+   * This list can be configured by key:
+   * "configuration.restrictions.baseID.spTransmission"
+   *
+   * @return
+   */
+  List<String> getTargetsWithNoBaseIdTransferRestriction();
+
+  /**
+   * Get the List eIDAS LoA that are required by this service provider.
+   *
+   * {@link at.gv.egiz.eaaf.core.api.data.EaafConstants.EIDAS_LOA_LOW}
+   * {@link at.gv.egiz.eaaf.core.api.data.EaafConstants.EIDAS_LOA_SUBSTANTIAL}
+   * {@link at.gv.egiz.eaaf.core.api.data.EaafConstants.EIDAS_LOA_HIGH} or any other non-notified LoA scheme
+   *
+   * @return return List of eIDAS LoAs
+   */
+  List<String> getRequiredLoA();
+
+  /**
+   * Get required matching mode for LoAs {@link EIDAS_LOA_MATCHING_MINIMUM}.
+   * {@link EIDAS_LOA_MATCHING_EXACT}
+   *
+   * @return
+   */
+  String getLoAMatchingMode();
+
+  /**
+   * Get the full area-identifier for this service provider to calculate the
+   * area-specific unique person identifier (bPK, wbPK, eIDAS unique identifier,
+   * ...). This identifier always contains the full prefix
+   *
+   * @return area identifier with prefix
+   */
+  String getAreaSpecificTargetIdentifier();
+
+}