-/*-\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
+/*-
+ * ================================================================================
+ * ECOMP Portal
+ * ================================================================================
+ * Copyright (C) 2017 AT&T Intellectual Property
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file 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.
+ * ================================================================================
+ */
+package org.openecomp.portalapp.portal.service;
+
+import java.util.HashMap;
+
+import org.openecomp.portalapp.command.EPLoginBean;
+import org.openecomp.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);
+}
Code Review / portal.git / blobdiff