aboutsummaryrefslogtreecommitdiffstats
path: root/capabilities
diff options
context:
space:
mode:
Diffstat (limited to 'capabilities')
-rw-r--r--capabilities/pom.xml43
-rw-r--r--capabilities/src/main/java/org/onap/policy/common/capabilities/Configurable.java43
-rw-r--r--capabilities/src/main/java/org/onap/policy/common/capabilities/Startable.java15
3 files changed, 54 insertions, 47 deletions
diff --git a/capabilities/pom.xml b/capabilities/pom.xml
index 1d1e290c..091001ac 100644
--- a/capabilities/pom.xml
+++ b/capabilities/pom.xml
@@ -1,7 +1,7 @@
<!--
============LICENSE_START=======================================================
Copyright (C) 2018 Ericsson. All rights reserved.
- Modifications Copyright (C) 2020 AT&T Intellectual Property. All rights reserved.
+ Modifications Copyright (C) 2020-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.
@@ -25,7 +25,7 @@
<parent>
<groupId>org.onap.policy.common</groupId>
<artifactId>common-modules</artifactId>
- <version>1.6.2-SNAPSHOT</version>
+ <version>2.1.3-SNAPSHOT</version>
</parent>
<artifactId>capabilities</artifactId>
@@ -33,44 +33,7 @@
<packaging>jar</packaging>
<properties>
- <!-- There is no code in this sub-module, only holds interfaces. So skip sonar. -->
+ <!-- There is no code in this submodule, only holds interfaces. So skip sonar. -->
<sonar.skip>true</sonar.skip>
</properties>
-
- <build>
- <pluginManagement>
- <plugins>
- <!--This plugin's configuration is used to store Eclipse
- m2e settings only. It has no influence on the Maven build itself. -->
- <plugin>
- <groupId>org.eclipse.m2e</groupId>
- <artifactId>lifecycle-mapping</artifactId>
- <version>1.0.0</version>
- <configuration>
- <lifecycleMappingMetadata>
- <pluginExecutions>
- <pluginExecution>
- <pluginExecutionFilter>
- <groupId>org.jacoco</groupId>
- <artifactId>
- jacoco-maven-plugin
- </artifactId>
- <versionRange>
- [0.7.1.201405082137,)
- </versionRange>
- <goals>
- <goal>prepare-agent</goal>
- </goals>
- </pluginExecutionFilter>
- <action>
- <ignore />
- </action>
- </pluginExecution>
- </pluginExecutions>
- </lifecycleMappingMetadata>
- </configuration>
- </plugin>
- </plugins>
- </pluginManagement>
- </build>
</project>
diff --git a/capabilities/src/main/java/org/onap/policy/common/capabilities/Configurable.java b/capabilities/src/main/java/org/onap/policy/common/capabilities/Configurable.java
new file mode 100644
index 00000000..97286744
--- /dev/null
+++ b/capabilities/src/main/java/org/onap/policy/common/capabilities/Configurable.java
@@ -0,0 +1,43 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * ONAP
+ * ================================================================================
+ * Copyright (C) 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.common.capabilities;
+
+/**
+ * Object that can be configured.
+ *
+ * @param <T> type of parameters
+ */
+public interface Configurable<T> {
+
+ /**
+ * Determines if this object has been configured.
+ *
+ * @return {@code true} if this object has been configured, {@code false} otherwise
+ */
+ boolean isConfigured();
+
+ /**
+ * Configures this object.
+ *
+ * @param parameters configuration parameters
+ */
+ void configure(T parameters);
+}
diff --git a/capabilities/src/main/java/org/onap/policy/common/capabilities/Startable.java b/capabilities/src/main/java/org/onap/policy/common/capabilities/Startable.java
index 49af75f8..0ce4da54 100644
--- a/capabilities/src/main/java/org/onap/policy/common/capabilities/Startable.java
+++ b/capabilities/src/main/java/org/onap/policy/common/capabilities/Startable.java
@@ -3,6 +3,7 @@
* policy-core
* ================================================================================
* Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved.
+ * Modifications Copyright (C) 2023 Nordix Foundation.
* ================================================================================
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -29,33 +30,33 @@ public interface Startable {
* Start operation. This operation starts the entity.
*
* @return boolean. true if the start operation was successful, otherwise false.
- * @throws IllegalStateException. if the element is in a state that conflicts with the start
+ * @throws IllegalStateException if the element is in a state that conflicts with the start
* operation.
*/
- public boolean start();
+ boolean start();
/**
* Stop operation. The entity can be restarted again by invoking the start operation.
*
* @return boolean. true if the stop operation was successful, otherwise false.
- * @throws IllegalStateException. if the element is in a state that conflicts with the stop
+ * @throws IllegalStateException if the element is in a state that conflicts with the stop
* operation.
*/
- public boolean stop();
+ boolean stop();
/**
* shutdown operation. The terminate operation yields the entity unusuable. It cannot be
* (re)started.
*
- * @throws IllegalStateException. if the element is in a state that conflicts with the stop
+ * @throws IllegalStateException if the element is in a state that conflicts with the stop
* operation.
*/
- public void shutdown();
+ void shutdown();
/**
* Checks if the entity is alive.
*
* @return boolean. true if alive, otherwise false
*/
- public boolean isAlive();
+ boolean isAlive();
}