summaryrefslogtreecommitdiffstats
path: root/api-state-management
diff options
context:
space:
mode:
Diffstat (limited to 'api-state-management')
-rw-r--r--api-state-management/pom.xml54
-rw-r--r--api-state-management/src/main/java/org/onap/policy/drools/statemanagement/StateManagementFeatureApi.java173
-rw-r--r--api-state-management/src/main/java/org/onap/policy/drools/statemanagement/StateManagementFeatureApiConstants.java69
3 files changed, 0 insertions, 296 deletions
diff --git a/api-state-management/pom.xml b/api-state-management/pom.xml
deleted file mode 100644
index 419208dd..00000000
--- a/api-state-management/pom.xml
+++ /dev/null
@@ -1,54 +0,0 @@
-<!--
- ============LICENSE_START=======================================================
- ONAP Policy Engine - Drools PDP
- ================================================================================
- Copyright (C) 2017, 2019-2021 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=========================================================
- -->
-
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-
- <modelVersion>4.0.0</modelVersion>
-
- <parent>
- <groupId>org.onap.policy.drools-pdp</groupId>
- <artifactId>drools-pdp</artifactId>
- <version>1.10.1-SNAPSHOT</version>
- </parent>
-
- <artifactId>api-state-management</artifactId>
-
- <name>api-state-management</name>
- <description>Separately loadable module for state management APIe</description>
-
- <dependencies>
- <dependency>
- <groupId>org.onap.policy.drools-pdp</groupId>
- <artifactId>policy-core</artifactId>
- <version>${project.version}</version>
- <scope>provided</scope>
- </dependency>
- <dependency>
- <groupId>org.onap.policy.common</groupId>
- <artifactId>integrity-monitor</artifactId>
- <version>${policy.common.version}</version>
- </dependency>
- <dependency>
- <groupId>org.projectlombok</groupId>
- <artifactId>lombok</artifactId>
- <scope>provided</scope>
- </dependency>
- </dependencies>
-</project>
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();
-}
diff --git a/api-state-management/src/main/java/org/onap/policy/drools/statemanagement/StateManagementFeatureApiConstants.java b/api-state-management/src/main/java/org/onap/policy/drools/statemanagement/StateManagementFeatureApiConstants.java
deleted file mode 100644
index 04e6011e..00000000
--- a/api-state-management/src/main/java/org/onap/policy/drools/statemanagement/StateManagementFeatureApiConstants.java
+++ /dev/null
@@ -1,69 +0,0 @@
-/*-
- * ============LICENSE_START=======================================================
- * policy-core
- * ================================================================================
- * Copyright (C) 2019, 2021 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 lombok.AccessLevel;
-import lombok.Getter;
-import lombok.NoArgsConstructor;
-import org.onap.policy.common.im.StateManagement;
-import org.onap.policy.common.utils.services.OrderedServiceImpl;
-
-@NoArgsConstructor(access = AccessLevel.PRIVATE)
-public final class StateManagementFeatureApiConstants {
-
- public static final String LOCKED = StateManagement.LOCKED;
- public static final String UNLOCKED = StateManagement.UNLOCKED;
- public static final String ENABLED = StateManagement.ENABLED;
- public static final String DISABLED = StateManagement.DISABLED;
- public static final String ENABLE_NOT_FAILED = StateManagement.ENABLE_NOT_FAILED_ACTION;
- public static final String DISABLE_FAILED = StateManagement.DISABLE_FAILED_ACTION;
- public static final String FAILED = StateManagement.FAILED;
- public static final String DEPENDENCY = StateManagement.DEPENDENCY;
- public static final String DEPENDENCY_FAILED = StateManagement.DEPENDENCY_FAILED;
- public static final String DISABLE_DEPENDENCY = StateManagement.DISABLE_DEPENDENCY_ACTION;
- public static final String ENABLE_NO_DEPENDENCY = StateManagement.ENABLE_NO_DEPENDENCY_ACTION;
- public static final String NULL_VALUE = StateManagement.NULL_VALUE;
- public static final String DO_LOCK = StateManagement.LOCK_ACTION;
- public static final String DO_UNLOCK = StateManagement.UNLOCK_ACTION;
- public static final String DO_PROMOTE = StateManagement.PROMOTE_ACTION;
- public static final String DO_DEMOTE = StateManagement.DEMOTE_ACTION;
- public static final String HOT_STANDBY = StateManagement.HOT_STANDBY;
- public static final String COLD_STANDBY = StateManagement.COLD_STANDBY;
- public static final String PROVIDING_SERVICE = StateManagement.PROVIDING_SERVICE;
-
- public static final String ADMIN_STATE = StateManagement.ADMIN_STATE;
- public static final String OPERATION_STATE = StateManagement.OPERATION_STATE;
- public static final String AVAILABLE_STATUS = StateManagement.AVAILABLE_STATUS;
- public static final String STANDBY_STATUS = StateManagement.STANDBY_STATUS;
-
- public static final Boolean ALLSEEMSWELL_STATE = Boolean.TRUE;
- public static final Boolean ALLNOTWELL_STATE = Boolean.FALSE;
-
- public static final int SEQ_NUM = 0;
-
- /**
- * 'FeatureAPI.impl.getList()' returns an ordered list of objects implementing the 'FeatureAPI'
- * interface.
- */
- @Getter
- private static final OrderedServiceImpl<StateManagementFeatureApi> impl =
- new OrderedServiceImpl<>(StateManagementFeatureApi.class);
-}