Create interfaces for Policy Distribution

Created interfaces and some skeletal implementations. Implememtations to
be further developed in subsequent stories

Change-Id: If55be78e34c8783451cb9aa755a563bc0850e569
Issue-ID: POLICY-1029
Signed-off-by: mmis <michael.morris@ericsson.com>

4 files changed, 138 insertions, 0 deletions

diff --git a/forwarding/pom.xml b/forwarding/pom.xml
index 741d6772..d2bcc29e 100644
--- a/forwarding/pom.xml
+++ b/forwarding/pom.xml
@@ -30,4 +30,12 @@
 
     <name>${project.artifactId}</name>
     <description>The module of Policy Distribution that forwards policies to other components.</description>
+    
+    <dependencies>
+        <dependency>
+            <groupId>org.onap.policy.distribution</groupId>
+            <artifactId>distribution-model</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+    </dependencies>
 </project>
diff --git a/forwarding/src/main/java/org/onap/policy/distribution/forwarding/PolicyForwarder.java b/forwarding/src/main/java/org/onap/policy/distribution/forwarding/PolicyForwarder.java
new file mode 100644
index 00000000..5272fc9b
--- /dev/null
+++ b/forwarding/src/main/java/org/onap/policy/distribution/forwarding/PolicyForwarder.java
@@ -0,0 +1,39 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2018 Ericsson. 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.
+ * 
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.distribution.forwarding;
+
+import java.util.Collection;
+import org.onap.policy.distribution.model.Policy;
+
+/**
+ * Forwards polices.
+ */
+public interface PolicyForwarder {
+
+    /**
+     * Forward the given policies.
+     * 
+     * @param policies the policies to forward
+     * @throws PolicyForwardingException if an error occurs when forwarding the given policy
+     */
+    void forward(Collection<Policy> policies) throws PolicyForwardingException;
+
+}
diff --git a/forwarding/src/main/java/org/onap/policy/distribution/forwarding/PolicyForwardingException.java b/forwarding/src/main/java/org/onap/policy/distribution/forwarding/PolicyForwardingException.java
new file mode 100644
index 00000000..1c99c5e4
--- /dev/null
+++ b/forwarding/src/main/java/org/onap/policy/distribution/forwarding/PolicyForwardingException.java
@@ -0,0 +1,49 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2018 Ericsson. 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.
+ * 
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.distribution.forwarding;
+
+/**
+ * An error has occured when forwarding a policy.
+ */
+public class PolicyForwardingException extends Exception {
+
+    private static final long serialVersionUID = 3866850096319435806L;
+
+    /**
+     * Construct an instance with the given message.
+     * 
+     * @param message the error message
+     */
+    public PolicyForwardingException(String message) {
+        super(message);
+    }
+
+    /**
+     * Construct an instance with the given message and cause.
+     * 
+     * @param message the error message
+     * @param cause the cause
+     */
+    public PolicyForwardingException(String message, Throwable cause) {
+        super(message, cause);
+    }
+
+}
diff --git a/forwarding/src/test/java/org/onap/policy/distribution/forwarding/PolicyDecodingExceptionTest.java b/forwarding/src/test/java/org/onap/policy/distribution/forwarding/PolicyDecodingExceptionTest.java
new file mode 100644
index 00000000..4b9ed273
--- /dev/null
+++ b/forwarding/src/test/java/org/onap/policy/distribution/forwarding/PolicyDecodingExceptionTest.java
@@ -0,0 +1,42 @@
+/*-
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2018 Ericsson. 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.
+ * 
+ * SPDX-License-Identifier: Apache-2.0
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.distribution.forwarding;
+
+import static org.junit.Assert.assertEquals;
+import org.junit.Test;
+
+public class PolicyDecodingExceptionTest {
+
+    @Test
+    public void testPolicyDecodingExceptionString() {
+        PolicyForwardingException policyDecodingException = new PolicyForwardingException("error message");
+        assertEquals("error message", policyDecodingException.getMessage());
+    }
+
+    @Test
+    public void testPolicyDecodingExceptionStringThrowable() {
+        Exception cause = new IllegalArgumentException();
+        PolicyForwardingException policyDecodingException = new PolicyForwardingException("error message", cause);
+        assertEquals("error message", policyDecodingException.getMessage());
+        assertEquals(cause, policyDecodingException.getCause());
+    }
+
+}