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.List;
42 import org.onap.portalapp.portal.domain.SharedContext;
45 * Defines the methods exposed by the service that manages shared context
46 * objects in the database.
48 public interface SharedContextService {
51 * Gets all shared context objects for the specified context ID.
55 * @return List of SharedContext objects
57 List<SharedContext> getSharedContexts(String contextId);
60 * Gets the shared context with the specified context ID and key.
63 * Context ID; usually a session ID
65 * Key for the key-value pair
66 * @return Value found in the database, null if any parameter is null or no
67 * shared context exists with that context ID - key pair.
69 SharedContext getSharedContext(String contextId, String key);
72 * Creates a new shared context entry with the specified context ID, key and
78 * Key for the key-value pair.
80 * Value for the key-value pair.
82 void addSharedContext(String contextId, String key, String value);
85 * Saves the specified shared context.
88 * SharedContext object to save.
90 void saveSharedContext(SharedContext context);
93 * Deletes the specified shared context.
96 * SharedContext object to delete.
98 void deleteSharedContext(SharedContext context);
101 * Deletes all shared contexts with the specified context ID.
104 * Context ID; usually a session ID
105 * @return number of shared-context objects deleted
107 int deleteSharedContexts(String contextId);
110 * Deletes all shared contexts with a creation time that is older than the
113 * @param ageInSeconds
114 * Expiration threshold in seconds
116 void expireSharedContexts(int ageInSeconds);