aboutsummaryrefslogtreecommitdiffstats
path: root/ccsdk-app-common/src/main/java/org/onap/ccsdk/dashboard/service/ControllerEndpointService.java
blob: 621de95d5d1729f1e9245acf4ce3443d15d18dec (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/*******************************************************************************
 * =============LICENSE_START=========================================================
 *
 * =================================================================================
 *  Copyright (c) 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 *  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.
 * ============LICENSE_END=========================================================
 *
 *  ECOMP is a trademark and service mark of AT&T Intellectual Property.
 *******************************************************************************/
package org.onap.ccsdk.dashboard.service;

import org.onap.ccsdk.dashboard.domain.ControllerEndpoint;

/**
 * Provides methods for managing the user's selection of controller endpoint.
 * 
 * No method throws a checked exception, in keeping with the Spring philosophy
 * of throwing unchecked exceptions.
 */
public interface ControllerEndpointService {

	/**
	 * Gets the object for the specified user ID.
	 * 
	 * @param userId
	 *            Application user ID
	 * @return ControllerEndpointCredentials instance; null if none exists.
	 */
	ControllerEndpoint getControllerEndpointSelection(long userId);

	/**
	 * Creates or updates an entry for the user ID specified within the object.
	 * 
	 * @param endpoint
	 *            info to store.
	 */
	void updateControllerEndpointSelection(ControllerEndpoint endpoint);

	/**
	 * Deletes the object for the specified user ID.
	 * 
	 * @param userId
	 *            Application user ID
	 */
	void deleteControllerEndpointSelection(long userId);

}