[PORTAL-7] Rebase

[portal.git] / ecomp-portal-BE-common / src / main / java / org / openecomp / portalapp / portal / service / EPLoginService.java

diff --git a/ecomp-portal-BE-common/src/main/java/org/openecomp/portalapp/portal/service/EPLoginService.java b/ecomp-portal-BE-common/src/main/java/org/openecomp/portalapp/portal/service/EPLoginService.java
new file mode 100644 (file)
index 0000000..4bdb200
--- /dev/null
+++ b/ecomp-portal-BE-common/src/main/java/org/openecomp/portalapp/portal/service/EPLoginService.java
@@ -0,0 +1,70 @@
+/*-\r
+ * ================================================================================\r
+ * ECOMP Portal\r
+ * ================================================================================\r
+ * Copyright (C) 2017 AT&T Intellectual Property\r
+ * ================================================================================\r
+ * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ * \r
+ *      http://www.apache.org/licenses/LICENSE-2.0\r
+ * \r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ * ================================================================================\r
+ */\r
+package org.openecomp.portalapp.portal.service;\r
+\r
+import java.util.HashMap;\r
+\r
+import org.openecomp.portalapp.command.EPLoginBean;\r
+import org.openecomp.portalapp.portal.domain.EPUser;\r
+\r
+public interface EPLoginService {\r
+\r
+       /**\r
+        * Calls {@link #findUser(EPLoginBean, String, HashMap, boolean)} with the\r
+        * last parameter set to true.\r
+        * \r
+        * @param bean\r
+        * @param menuPropertiesFilename\r
+        * @param additionalParams\r
+        * @return EPUser object; null on error or if no match.\r
+        * @throws Exception\r
+        */\r
+       @SuppressWarnings("rawtypes")\r
+       EPLoginBean findUser(EPLoginBean bean, String menuPropertiesFilename, HashMap additionalParams) throws Exception;\r
+\r
+       /**\r
+        * Searches the fn_user table for a row that matches information in the\r
+        * bean. Uses the bean's Organization User ID property if present; if not, uses the bean's\r
+        * LoginId property and (optionally, depending on matchPassword parameter)\r
+        * loginPwd property.\r
+        * \r
+        * @param bean\r
+        *            EPLoginBean\r
+        * @param menuPropertiesFileName\r
+        *            Always ignored\r
+        * @param additionalParams\r
+        *            Used by DataAccessService when updating a matched user object\r
+        * @param matchPassword\r
+        *            If true, the search must match the password\r
+        * @return EPUser object; null on error or if no match.\r
+        */\r
+       @SuppressWarnings("rawtypes")\r
+       EPLoginBean findUser(EPLoginBean bean, String menuPropertiesFilename, HashMap additionalParams,\r
+                       boolean matchPassword) throws Exception;\r
+\r
+       /**\r
+        * Searches the fn_user table for a row with a value in column login_id that\r
+        * matches the specified value.\r
+        * \r
+        * @param loginId\r
+        * @return EPUser object; null on error or if no match.\r
+        */\r
+       public EPUser findUserWithoutPwd(String loginId);\r
+}\r