Add decision models
Adding various decision models and their
serialization handler classes
Issue-ID: POLICY-1440
Change-Id: I35abfd9745a86b822f658ec3a512b7355cabf068
Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>
diff --git a/models-decisions/pom.xml b/models-decisions/pom.xml
new file mode 100644
index 0000000..230c5e4
--- /dev/null
+++ b/models-decisions/pom.xml
@@ -0,0 +1,41 @@
+<!--
+ ============LICENSE_START=======================================================
+ Copyright (C) 2019 Nordix Foundation.
+ ================================================================================
+ 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.
+
+ SPDX-License-Identifier: Apache-2.0
+ ============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.models</groupId>
+ <artifactId>policy-models</artifactId>
+ <version>2.0.0-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>models-decisions</artifactId>
+
+ <name>${project.artifactId}</name>
+ <description>The models for Policy Decision API's.</description>
+ <dependencies>
+ <dependency>
+ <groupId>org.onap.policy.common</groupId>
+ <artifactId>gson</artifactId>
+ <version>${policy.common.version}</version>
+ </dependency>
+ </dependencies>
+</project>
diff --git a/models-decisions/src/main/java/org/onap/policy/models/decisions/concepts/DecisionRequest.java b/models-decisions/src/main/java/org/onap/policy/models/decisions/concepts/DecisionRequest.java
new file mode 100644
index 0000000..94c9c95
--- /dev/null
+++ b/models-decisions/src/main/java/org/onap/policy/models/decisions/concepts/DecisionRequest.java
@@ -0,0 +1,51 @@
+/*
+ * ============LICENSE_START=======================================================
+ * ONAP Policy Decision Models
+ * ================================================================================
+ * Copyright (C) 2019 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.models.decisions.concepts;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.util.Map;
+
+import lombok.Data;
+
+/**
+ * This class is for a Decision Request to a Decision PDP Engine.
+ *
+ * @author pameladragosh
+ *
+ */
+@Data
+public class DecisionRequest {
+ @SerializedName("ONAPName")
+ private String onapName;
+
+ @SerializedName("ONAPComponent")
+ private String onapComponent;
+
+ @SerializedName("ONAPInstance")
+ private String onapInstance;
+
+ @SerializedName("action")
+ private String action;
+
+ @SerializedName("resource")
+ private Map<String, Object> resource;
+}
diff --git a/models-decisions/src/main/java/org/onap/policy/models/decisions/concepts/DecisionResponse.java b/models-decisions/src/main/java/org/onap/policy/models/decisions/concepts/DecisionResponse.java
new file mode 100644
index 0000000..b265fe4
--- /dev/null
+++ b/models-decisions/src/main/java/org/onap/policy/models/decisions/concepts/DecisionResponse.java
@@ -0,0 +1,39 @@
+/*
+ * ============LICENSE_START=======================================================
+ * ONAP Policy Decision Models
+ * ================================================================================
+ * Copyright (C) 2019 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.models.decisions.concepts;
+
+import java.util.List;
+import java.util.Map;
+
+import lombok.Data;
+
+/**
+ * Generic class for handling Decision Response objects.
+ *
+ * @author pameladragosh
+ *
+ */
+@Data
+public class DecisionResponse {
+
+ private String errorMessage;
+ private List<Map<String, Object>> policies;
+}
diff --git a/models-decisions/src/main/java/org/onap/policy/models/decisions/serialization/DecisionRequestMessageBodyHandler.java b/models-decisions/src/main/java/org/onap/policy/models/decisions/serialization/DecisionRequestMessageBodyHandler.java
new file mode 100644
index 0000000..9e4438b
--- /dev/null
+++ b/models-decisions/src/main/java/org/onap/policy/models/decisions/serialization/DecisionRequestMessageBodyHandler.java
@@ -0,0 +1,53 @@
+/*
+ * ============LICENSE_START=======================================================
+ * ONAP Policy Decision Models
+ * ================================================================================
+ * Copyright (C) 2019 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.models.decisions.serialization;
+
+import com.google.gson.GsonBuilder;
+
+import org.onap.policy.common.gson.GsonMessageBodyHandler;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+
+/**
+ * Handles parsing DecisionRequests.
+ *
+ * @author pameladragosh
+ *
+ */
+public class DecisionRequestMessageBodyHandler extends GsonMessageBodyHandler {
+
+ public static final Logger logger = LoggerFactory.getLogger(DecisionRequestMessageBodyHandler.class);
+
+ /**
+ * Empty constructor.
+ */
+ public DecisionRequestMessageBodyHandler() {
+ this(new GsonBuilder());
+
+ logger.info("Using GSON with DecisionRequest for REST calls");
+ }
+
+ public DecisionRequestMessageBodyHandler(GsonBuilder builder) {
+ super(builder.create());
+ }
+}
diff --git a/models-decisions/src/main/java/org/onap/policy/models/decisions/serialization/DecisionResponseMessageBodyHandler.java b/models-decisions/src/main/java/org/onap/policy/models/decisions/serialization/DecisionResponseMessageBodyHandler.java
new file mode 100644
index 0000000..5d1195e
--- /dev/null
+++ b/models-decisions/src/main/java/org/onap/policy/models/decisions/serialization/DecisionResponseMessageBodyHandler.java
@@ -0,0 +1,46 @@
+/*
+ * ============LICENSE_START=======================================================
+ * ONAP Policy Decision Models
+ * ================================================================================
+ * Copyright (C) 2019 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.models.decisions.serialization;
+
+import com.google.gson.GsonBuilder;
+
+import org.onap.policy.common.gson.GsonMessageBodyHandler;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class DecisionResponseMessageBodyHandler extends GsonMessageBodyHandler {
+
+ public static final Logger logger = LoggerFactory.getLogger(DecisionResponseMessageBodyHandler.class);
+
+ /**
+ * Empty constructor.
+ */
+ public DecisionResponseMessageBodyHandler() {
+ this(new GsonBuilder());
+
+ logger.info("Using GSON with DecisionResponse for REST calls");
+ }
+
+ public DecisionResponseMessageBodyHandler(GsonBuilder builder) {
+ super(builder.create());
+ }
+}
diff --git a/models-decisions/src/test/java/org/onap/policy/models/decisions/concepts/TestModels.java b/models-decisions/src/test/java/org/onap/policy/models/decisions/concepts/TestModels.java
new file mode 100644
index 0000000..25b1016
--- /dev/null
+++ b/models-decisions/src/test/java/org/onap/policy/models/decisions/concepts/TestModels.java
@@ -0,0 +1,41 @@
+/*
+ * ============LICENSE_START=======================================================
+ * ONAP Policy Decision Models
+ * ================================================================================
+ * Copyright (C) 2019 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.models.decisions.concepts;
+
+import com.openpojo.reflection.filters.FilterPackageInfo;
+import com.openpojo.validation.Validator;
+import com.openpojo.validation.ValidatorBuilder;
+import com.openpojo.validation.test.impl.GetterTester;
+import com.openpojo.validation.test.impl.SetterTester;
+
+import org.junit.Test;
+import org.onap.policy.common.utils.validation.ToStringTester;
+
+public class TestModels {
+
+ @Test
+ public void testDecisionModels() {
+ final Validator validator = ValidatorBuilder.create().with(new ToStringTester()).with(new SetterTester())
+ .with(new GetterTester()).build();
+ validator.validate(TestModels.class.getPackage().getName(), new FilterPackageInfo());
+ }
+
+}
diff --git a/pom.xml b/pom.xml
index 3d18359..c0df329 100644
--- a/pom.xml
+++ b/pom.xml
@@ -56,6 +56,7 @@
<module>models-dao</module>
<module>models-tosca</module>
<module>models-pap</module>
+ <module>models-decisions</module>
<module>models-provider</module>
</modules>