2 * ============LICENSE_START==========================================
4 * ===================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6 * ===================================================================
8 * Unless otherwise specified, all software contained herein is licensed
9 * under the Apache License, Version 2.0 (the "License");
10 * you may not use this software except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
21 * Unless otherwise specified, all documentation contained herein is licensed
22 * under the Creative Commons License, Attribution 4.0 Intl. (the "License");
23 * you may not use this documentation except in compliance with the License.
24 * You may obtain a copy of the License at
26 * https://creativecommons.org/licenses/by/4.0/
28 * Unless required by applicable law or agreed to in writing, documentation
29 * distributed under the License is distributed on an "AS IS" BASIS,
30 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
31 * See the License for the specific language governing permissions and
32 * limitations under the License.
34 * ============LICENSE_END============================================
38 package org.onap.portalapp.portal.service;
40 import java.util.HashMap;
42 import org.onap.portalapp.command.EPLoginBean;
43 import org.onap.portalapp.portal.domain.EPUser;
45 public interface EPLoginService {
48 * Calls {@link #findUser(EPLoginBean, String, HashMap, boolean)} with the
49 * last parameter set to true.
52 * @param menuPropertiesFilename
53 * @param additionalParams
54 * @return EPUser object; null on error or if no match.
57 @SuppressWarnings("rawtypes")
58 EPLoginBean findUser(EPLoginBean bean, String menuPropertiesFilename, HashMap additionalParams) throws Exception;
61 * Searches the fn_user table for a row that matches information in the
62 * bean. Uses the bean's Organization User ID property if present; if not,
63 * uses the bean's LoginId property and (optionally, depending on
64 * matchPassword parameter) loginPwd property.
68 * @param menuPropertiesFileName
70 * @param additionalParams
71 * Used by DataAccessService when updating a matched user object
72 * @param matchPassword
73 * If true, the search must match the password
74 * @return EPUser object; null on error or if no match.
77 @SuppressWarnings("rawtypes")
78 EPLoginBean findUser(EPLoginBean bean, String menuPropertiesFileName, HashMap additionalParams,
79 boolean matchPassword) throws Exception;
82 * Searches the fn_user table for a row with a value in column login_id that
83 * matches the specified value.
87 * @return EPUser object; null on error or if no match.
89 public EPUser findUserWithoutPwd(String loginId);