From bee5dd259a4438d45ecd1bcc26dfba12875236d6 Mon Sep 17 00:00:00 2001
From: Thomas Lenz <thomas.lenz@egiz.gv.at>
Date: Tue, 26 Jun 2018 11:03:48 +0200
Subject: initial commit

---
 .../at/gv/egiz/eaaf/core/api/idp/IModulInfo.java   | 75 ++++++++++++++++++++++
 1 file changed, 75 insertions(+)
 create mode 100644 eaaf_core/src/main/java/at/gv/egiz/eaaf/core/api/idp/IModulInfo.java

(limited to 'eaaf_core/src/main/java/at/gv/egiz/eaaf/core/api/idp/IModulInfo.java')

diff --git a/eaaf_core/src/main/java/at/gv/egiz/eaaf/core/api/idp/IModulInfo.java b/eaaf_core/src/main/java/at/gv/egiz/eaaf/core/api/idp/IModulInfo.java
new file mode 100644
index 00000000..03a761f2
--- /dev/null
+++ b/eaaf_core/src/main/java/at/gv/egiz/eaaf/core/api/idp/IModulInfo.java
@@ -0,0 +1,75 @@
+/*******************************************************************************
+ *******************************************************************************/
+/*******************************************************************************
+ * 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.egiz.eaaf.core.api.idp;
+
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import at.gv.egiz.eaaf.core.api.IRequest;
+
+/**
+ * Basic interface of an authentication protocol implementation on IDP side
+ * 
+ * @author tlenz
+ *
+ */
+public interface IModulInfo {
+	
+	/**
+	 * Name of this IDP authentication module
+	 * 
+	 * @return
+	 */
+	public String getName();
+	
+	/**
+	 * Authentication protocol identifier for this module
+	 * 
+	 * @return
+	 */
+	public String getAuthProtocolIdentifier();
+	
+	/**
+	 * Generates a protocol specific error message
+	 * 
+	 * 
+	 * @param e Exception that contains the error message
+	 * @param request httpRequest object from servlet container
+	 * @param response httpResponse object from servlet container
+	 * @param protocolRequest incoming protocol request
+	 * @return return <i>true</i> if a protocol specific error message was generated, otherwise <i>false</i>
+	 * @throws Throwable
+	 */
+	public boolean generateErrorMessage(Throwable e,
+			HttpServletRequest request, HttpServletResponse response,
+			IRequest protocolRequest) throws Throwable;
+	
+	/**
+	 * additional validation of a incoming authentication request 
+	 * 
+	 * @param request httpRequest object from servlet container
+	 * @param response httpResponse object from servlet container
+	 * @param pending incoming protocol request
+	 * @return return <i>true</i> if the incoming request is valid, otherwise <i>false</i>
+	 */
+	public boolean validate(HttpServletRequest request, 
+			HttpServletResponse response, IRequest pending);
+}
-- 
cgit v1.2.3