-/*-\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.List;\r
-\r
-import org.openecomp.portalapp.portal.domain.SharedContext;\r
-\r
-/**\r
- * Defines the methods exposed by the service that manages shared context\r
- * objects in the database via Hibernate.\r
- */\r
-public interface SharedContextService {\r
-\r
- /**\r
- * Gets all shared context objects for the specified context ID.\r
- * \r
- * @return List of SharedContext objects\r
- */\r
- List<SharedContext> getSharedContexts(String contextId);\r
-\r
- /**\r
- * Gets the shared context with the specified context ID and key.\r
- * \r
- * @param contextId\r
- * Context ID; usually a session ID\r
- * @param key\r
- * Key for the key-value pair\r
- * @return Value found in the database, null if any parameter is null or no\r
- * shared context exists with that context ID - key pair.\r
- */\r
- SharedContext getSharedContext(String contextId, String key);\r
-\r
- /**\r
- * Creates a new shared context in the database with the specified context\r
- * ID, key and value.\r
- * \r
- * @param context\r
- * SharedContext object to save.\r
- * @param key\r
- * Key for the key-value pair.\r
- * @param value\r
- * Value for the key-value pair.\r
- */\r
- void addSharedContext(String contextId, String key, String value);\r
-\r
- /**\r
- * Saves the specified shared context to the database.\r
- * \r
- * @param context\r
- * SharedContext object to save.\r
- */\r
- void saveSharedContext(SharedContext context);\r
-\r
- /**\r
- * Deletes the specified shared context from the database.\r
- * \r
- * @param context\r
- * SharedContext object to delete.\r
- */\r
- void deleteSharedContext(SharedContext context);\r
-\r
- /**\r
- * Deletes all shared contexts with the specified context ID.\r
- * \r
- * @param contextId\r
- * Context ID; usually a session ID\r
- * @return number of shared-context objects deleted\r
- */\r
- int deleteSharedContexts(String contextId);\r
-\r
- /**\r
- * Deletes all shared contexts with a creation time that is older than the\r
- * specified value.\r
- * \r
- * @param ageInSeconds\r
- * Expiration threshold in seconds\r
- */\r
- void expireSharedContexts(int ageInSeconds);\r
-\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.List;
+
+import org.openecomp.portalapp.portal.domain.SharedContext;
+
+/**
+ * Defines the methods exposed by the service that manages shared context
+ * objects in the database.
+ */
+public interface SharedContextService {
+
+ /**
+ * Gets all shared context objects for the specified context ID.
+ *
+ * @param contextId
+ * SharedContext ID
+ * @return List of SharedContext objects
+ */
+ List<SharedContext> getSharedContexts(String contextId);
+
+ /**
+ * Gets the shared context with the specified context ID and key.
+ *
+ * @param contextId
+ * Context ID; usually a session ID
+ * @param key
+ * Key for the key-value pair
+ * @return Value found in the database, null if any parameter is null or no
+ * shared context exists with that context ID - key pair.
+ */
+ SharedContext getSharedContext(String contextId, String key);
+
+ /**
+ * Creates a new shared context entry with the specified context ID, key and
+ * value.
+ *
+ * @param contextId
+ * SharedContext ID
+ * @param key
+ * Key for the key-value pair.
+ * @param value
+ * Value for the key-value pair.
+ */
+ void addSharedContext(String contextId, String key, String value);
+
+ /**
+ * Saves the specified shared context.
+ *
+ * @param context
+ * SharedContext object to save.
+ */
+ void saveSharedContext(SharedContext context);
+
+ /**
+ * Deletes the specified shared context.
+ *
+ * @param context
+ * SharedContext object to delete.
+ */
+ void deleteSharedContext(SharedContext context);
+
+ /**
+ * Deletes all shared contexts with the specified context ID.
+ *
+ * @param contextId
+ * Context ID; usually a session ID
+ * @return number of shared-context objects deleted
+ */
+ int deleteSharedContexts(String contextId);
+
+ /**
+ * Deletes all shared contexts with a creation time that is older than the
+ * specified value.
+ *
+ * @param ageInSeconds
+ * Expiration threshold in seconds
+ */
+ void expireSharedContexts(int ageInSeconds);
+
+}
Code Review / portal.git / blobdiff