refactor the GUI generation for user interaction

1 files changed, 222 insertions, 0 deletions

diff --git a/id/server/moa-id-commons/src/main/java/at/gv/egovernment/moa/id/commons/api/IOAAuthParameters.java b/id/server/moa-id-commons/src/main/java/at/gv/egovernment/moa/id/commons/api/IOAAuthParameters.java
new file mode 100644
index 000000000..be6d34275
--- /dev/null
+++ b/id/server/moa-id-commons/src/main/java/at/gv/egovernment/moa/id/commons/api/IOAAuthParameters.java
@@ -0,0 +1,222 @@
+/*
+ * Copyright 2014 Federal Chancellery Austria
+ * MOA-ID has been developed in a cooperation between BRZ, the Federal
+ * Chancellery Austria - ICT staff unit, and Graz University of Technology.
+ *
+ * Licensed under the EUPL, Version 1.1 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:
+ * http://www.osor.eu/eupl/
+ *
+ * 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.egovernment.moa.id.commons.api;
+
+import java.security.PrivateKey;
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+
+import at.gv.egovernment.moa.id.commons.api.data.CPEPS;
+import at.gv.egovernment.moa.id.commons.api.data.SAML1ConfigurationParameters;
+import at.gv.egovernment.moa.id.commons.api.data.StorkAttribute;
+import at.gv.egovernment.moa.id.commons.api.data.StorkAttributeProviderPlugin;
+
+/**
+ * @author tlenz
+ *
+ */
+public interface IOAAuthParameters {
+
+	public static final String ONLINEBKU = "online";
+	public static final String HANDYBKU = "handy";
+	public static final String LOCALBKU = "local";
+	public static final String INDERFEDERATEDIDP = "interfederated";
+
+	/**
+	 * Get the full key/value configuration for this online application
+	 * 
+	 * @return an unmodifiable map of key/value pairs
+	 */
+	public Map<String, String> getFullConfiguration();
+	
+	  /**
+	   * Get a configuration value from online application 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
+	   */  
+	public String getConfigurationValue(String key);
+	
+	public String getFriendlyName();
+	
+	public String getPublicURLPrefix();
+
+	public String getOaType();
+	
+	public boolean getBusinessService();
+	
+	/**
+	 * Get target of a public service-provider
+	 * 
+	 * @return target identifier without prefix
+	 */
+	public String getTarget();
+	
+	public String getTargetFriendlyName();
+	
+	public boolean isInderfederationIDP();
+	
+	public boolean isSTORKPVPGateway();
+	
+	public boolean isRemovePBKFromAuthBlock();
+	
+	/**
+	 * Return the private-service domain-identifier with PreFix
+	 * 
+	 * @return the identityLinkDomainIdentifier
+	 */
+	public String getIdentityLinkDomainIdentifier();
+
+	/**
+	 * @return the keyBoxIdentifier
+	 */
+	public String getKeyBoxIdentifier();
+
+	public SAML1ConfigurationParameters getSAML1Parameter();
+
+	/**
+	 * Get a list of online application specific trusted security layer templates 
+	 * 
+	 * @return a {List<String>} with template URLs, maybe empty but never null
+	 */
+	public List<String> getTemplateURL();
+
+	
+	/**
+	 * Return the additional AuthBlock text for this online application
+	 * 
+	 * @return authblock text {String} or null if no text is configured
+	 */
+	public String getAditionalAuthBlockText();
+
+	/**
+	 * Return an online application specific BKU URL for a requested BKU type
+	 * 
+	 * @param bkutype: defines the type of BKU 
+	 * @return BKU URL {String} or null if no BKU URL is configured
+	 */
+	public String getBKUURL(String bkutype);
+
+	/**
+	 * Return a list of all configured BKU URLs for this online application
+	 * 
+	 * @return List<String> of BKU URLs or an empty list if no BKU is configured
+	 */
+	public List<String> getBKUURL();
+
+	public boolean useSSO();
+
+	public boolean useSSOQuestion();
+
+	/**
+	 * Return all mandate-profile types configured for this online application
+	 * 
+	 * @return the mandateProfiles {List<String>} or null if no profile is defined
+	 */
+	public List<String> getMandateProfiles();
+
+	/**
+	 * @return the identityLinkDomainIdentifierType
+	 */
+	public String getIdentityLinkDomainIdentifierType();
+
+	public boolean isShowMandateCheckBox();
+
+	public boolean isOnlyMandateAllowed();
+
+	/**
+	 * Shall we show the stork login in the bku selection frontend?
+	 * 
+	 * @return true, if is we should show stork login
+	 */
+	public boolean isShowStorkLogin();
+
+	public Integer getQaaLevel();
+
+	public boolean isRequireConsentForStorkAttributes();
+
+	/**
+	 * Return a {Collection} of requested STORK attributes
+	 * 
+	 * @return {Collection<StorkAttribute>} maybe empty but never null
+	 */
+	public Collection<StorkAttribute> getRequestedSTORKAttributes();
+
+	public byte[] getBKUSelectionTemplate();
+
+	public byte[] getSendAssertionTemplate();
+
+	/**
+	 * Return a {Collection} of configured STORK CPEPS 
+	 * 
+	 * @return {Collection<CPEPS>} maybe empty but never null
+	 */
+	public Collection<CPEPS> getPepsList();
+
+	public String getIDPAttributQueryServiceURL();
+
+	/**
+	 * @return
+	 */
+	boolean isInboundSSOInterfederationAllowed();
+
+	/**
+	 * @return
+	 */
+	boolean isInterfederationSSOStorageAllowed();
+
+	/**
+	 * @return
+	 */
+	boolean isOutboundSSOInterfederationAllowed();
+	
+	boolean isTestCredentialEnabled();
+
+	List<String> getTestCredentialOIDs();
+	
+	boolean isUseIDLTestTrustStore();
+	boolean isUseAuthBlockTestTestStore();
+	
+	PrivateKey getBPKDecBpkDecryptionKey();
+
+	/** 
+	 * @return
+	 */
+	boolean isPassivRequestUsedForInterfederation();
+
+	/**
+	 * @return
+	 */
+	boolean isPerformLocalAuthenticationOnInterfederationError();
+
+	/**
+	 * Get a {Collection} of configured STORK attribute provider plug-ins
+	 * 
+	 * @return {Collection<StorkAttributeProviderPlugins>} maybe empty but never null
+	 */
+	public Collection<StorkAttributeProviderPlugin> getStorkAPs();
+	
+	public List<Integer> getReversionsLoggingEventCodes();
+	
+}
\ No newline at end of file