diff options
Diffstat (limited to 'api-state-management/src/main/java/org/onap/policy/drools/statemanagement/StateManagementFeatureApi.java')
| -rw-r--r-- | api-state-management/src/main/java/org/onap/policy/drools/statemanagement/StateManagementFeatureApi.java | 173 |
1 files changed, 0 insertions, 173 deletions
diff --git a/api-state-management/src/main/java/org/onap/policy/drools/statemanagement/StateManagementFeatureApi.java b/api-state-management/src/main/java/org/onap/policy/drools/statemanagement/StateManagementFeatureApi.java deleted file mode 100644 index c4ba8622..00000000 --- a/api-state-management/src/main/java/org/onap/policy/drools/statemanagement/StateManagementFeatureApi.java +++ /dev/null @@ -1,173 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * policy-core - * ================================================================================ - * Copyright (C) 2017-2020 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========================================================= - */ - -package org.onap.policy.drools.statemanagement; - -import javax.validation.constraints.NotNull; -import org.onap.policy.common.capabilities.Lockable; -import org.onap.policy.common.im.AllSeemsWellException; -import org.onap.policy.common.im.IntegrityMonitorException; -import org.onap.policy.common.im.StateChangeNotifier; -import org.onap.policy.common.im.StateManagementException; -import org.onap.policy.common.utils.services.OrderedService; - -/** - * This interface provides a way to invoke optional features at various points in the code. At - * appropriate points in the application, the code iterates through this list, invoking these - * optional methods. Most of the methods here are notification only -- these tend to return a 'void' - * value. In other cases, such as 'activatePolicySession', may - */ -public interface StateManagementFeatureApi extends OrderedService, Lockable { - - /** - * ALL SEEMS/NOT WELL This interface is used to support the concept of All Seems/Not Well. It - * provides a way for client code to indicate to the DroolsPDPIntegrityMonitor that an event has - * occurred which is disabling (or enabling) for the Drools PDP. The call is actually - * implemented in the common modules IntegrityMonitor where it will cause the testTransaction to - * fail if any module has set the value ALLNOTWELL, stopping the forward progress counter and - * eventually causing the operational state to become disabled. - * - * <p>ALLSEEMSWELL is passed to the method when the client is healthy ALLNOTWELL is passed to the - * method when the client is disabled - * - * @param key - This should be a unique identifier for the entity making the call (e.g., class - * name) - * @param asw - This is the indicator of health. See constants: ALLSEEMSWELL or ALLNOTWELL - * @param msg - A message is required. It should indicate why all is not well or a message - * indicating that a component has been restored to health (perhaps indicating the - * problem that has resolved). - * @throws AllSeemsWellException exception - */ - void allSeemsWell(@NotNull String key, @NotNull Boolean asw, @NotNull String msg) - throws AllSeemsWellException; - - /** - * This method is called to add an Observer to receive notifications of state changes. - * - * @param stateChangeObserver observer - */ - void addObserver(StateChangeNotifier stateChangeObserver); - - /** - * Returns the X.731 Administrative State for this resource. - * - * @return String (locked, unlocked) - */ - String getAdminState(); - - /** - * Returns the X.731 Operational State for this resource. - * - * @return String (enabled, disabled) - */ - String getOpState(); - - /** - * Returns the X.731 Availability Status for this resource. - * - * @return String (failed; dependency; dependency,failed) - */ - String getAvailStatus(); - - /** - * Returns the X.731 Standby Status for this resource. - * - * @return String (providingservice, hotstandby or coldstandby) - */ - String getStandbyStatus(); - - /** - * Returns the X.731 Standby Status for the named resource - * - * @param resourceName the resource name - * @return String (providingservice, hotstandby or coldstandby) - */ - String getStandbyStatus(String resourceName); - - /** - * This method moves the X.731 Operational State for the named resource into a value of disabled - * and the Availability Status to a value of failed. As a consequence the Standby Status value - * will take a value of coldstandby. - * - * @param resourceName resource name - * @throws StateManagementException exception - */ - void disableFailed(String resourceName) throws StateManagementException; - - /** - * This method moves the X.731 Operational State for this resource into a value of disabled and - * the Availability Status to a value of failed. As a consequence the Standby Status value will - * take a value of coldstandby. - * - * @throws StateManagementException exception - */ - void disableFailed() throws StateManagementException; - - /** - * This method moves the X.731 Standby Status for this resource from hotstandby to - * providingservice. If the current value is coldstandby, no change is made. If the current - * value is null, it will move to providingservice assuming the Operational State is enabled and - * Administrative State is unlocked. - * - * @throws IntegrityMonitorException exception - */ - void promote() throws IntegrityMonitorException; - - /** - * This method moves the X.731 Standby Status for this resource from providingservice to - * hotstandby. If the current value is null, it will move to hotstandby assuming the Operational - * State is enabled and Administrative State is unlocked. Else, it will move to coldstandby - * - * @throws StateManagementException exception - */ - void demote() throws StateManagementException; - - /** - * Returns the resourceName associated with this instance of the - * StateManagementFeature. - * - * @return String (resourceName) - */ - String getResourceName(); - - /** - * This Lockable method will lock the StateManagement object Admin state. - * - * @return true if successful, false otherwise - */ - @Override - boolean lock(); - - /** - * This Lockable method will unlock the StateManagement object Admin state. - * - * @return true if successfull, false otherwise - */ - @Override - boolean unlock(); - - /** - * This Lockable method indicates the Admin state StateManagement object. - * - * @return true if locked, false otherwise - */ - @Override - boolean isLocked(); -} |