Security/ Package Name changes

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

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